Account
GET Swift Account#
Gets project account.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/swiftaccounts |
| 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#
The request does not have a request body.
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": { "name": "string", "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "endpoint": "string", "defaultBucket": "string", "username": "string", "password": "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 | array [object] | Return the result of bucket s3 account | |
| name | string | "string" | |
| projectId | string($Guid) | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the project id |
| endpoint | string | "string" | Returns the endpoint |
| defaultBucket | string | "string" | Returns the default bucket for the specific project |
| username | string | "string" | Returns the username of the account |
| password | string | "string" | Returns the password of the account |
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