tapis-workflows 0.3.1

Create and manage pipelines
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

# \SecretsApi

All URIs are relative to *http://localhost:8000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_secret**](SecretsApi.md#create_secret) | **POST** /v3/workflows/secrets | Create a secret
[**delete_secret**](SecretsApi.md#delete_secret) | **DELETE** /v3/workflows/secrets/{secret_id} | Delete a secret
[**get_secret**](SecretsApi.md#get_secret) | **GET** /v3/workflows/secrets/{secret_id} | Retrieve a secret
[**list_secrets**](SecretsApi.md#list_secrets) | **GET** /v3/workflows/secrets | Retrieve secrets



## create_secret

> models::RespSecret create_secret(req_create_secret)
Create a secret

Create a secret. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**req_create_secret** | [**ReqCreateSecret**](ReqCreateSecret.md) | A JSON object specifying information for the pipeline to be created. | [required] |

### Return type

[**models::RespSecret**](RespSecret.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_secret

> models::RespString delete_secret(secret_id)
Delete a secret

Delete a secret and all of the objects that belong to them

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**secret_id** | **String** |  | [required] |

### Return type

[**models::RespString**](RespString.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_secret

> models::RespSecret get_secret(secret_id)
Retrieve a secret

Retrieve a secret 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**secret_id** | **String** |  | [required] |

### Return type

[**models::RespSecret**](RespSecret.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_secrets

> models::RespSecretList list_secrets()
Retrieve secrets

Retrieve all secrets for a user 

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::RespSecretList**](RespSecretList.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)