Chapter 60. Secret Service
60.1. Secret Service
60.1.1. CountSecrets
GET /v1/secretscount
CountSecrets returns the number of secrets.
60.1.1.1. Description
60.1.1.2. Parameters
60.1.1.2.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null |
60.1.1.3. Return Type
60.1.1.4. Content Type
- application/json
60.1.1.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
60.1.1.6. Samples
60.1.2. GetSecret
GET /v1/secrets/{id}
GetSecret returns a secret given its ID.
60.1.2.1. Description
60.1.2.2. Parameters
60.1.2.2.1. Path Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
id | X | null |
60.1.2.3. Return Type
60.1.2.4. Content Type
- application/json
60.1.2.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |
60.1.2.6. Samples
60.1.3. ListSecrets
GET /v1/secrets
ListSecrets returns the list of secrets.
60.1.3.1. Description
60.1.3.2. Parameters
60.1.3.2.1. Query Parameters
Name | Description | Required | Default | Pattern |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
pagination.sortOption.aggregateBy.distinct | - | null |
60.1.3.3. Return Type
60.1.3.4. Content Type
- application/json
60.1.3.5. Responses
Code | Message | Datatype |
---|---|---|
200 | A successful response. | |
0 | An unexpected error response. |