Keys
POST Swift Key#
Create Swift keys.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/storage/swift |
| Headers | Authorization |
| Parameters | projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string | v1 | Shows the version of API |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
Request body#
{ "name": "string"}The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | Sends the name of keys. |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "username": "string", "secretKey": "string" }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}
| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | object | Return the result of swift keys. | |
| username | string | "string" | Returns the username of keys. |
| secretKey | string | "string" | Returns the secret key. |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE Key#
Delete Swift key.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/storage/swift |
| Headers | Authorization |
| Parameters | projectId, version |
| Body | Not Applicable |
| Query | name |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
| Query Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| {name} | Yes | string | "string" | Sends the name of keys. |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| version | Yes | string | v1 | Shows the version of API |
| projectId | Yes | string | 2e21fae6-af4c-4a4a-e0fc-08d903f55711 | Shows the project Id |
Request body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 204 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found