Services
Apis
get
Example Usage
Parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
api_id | str | :heavy_check_mark: | N/A | api_1234 |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
create
Example Usage
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | models.CreateAPIRequestBody | :heavy_check_mark: | The request object to use for the request. |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
list_keys
Example Usage
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | models.ListKeysRequest | :heavy_check_mark: | The request object to use for the request. |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
delete
Example Usage
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | models.DeleteAPIRequestBody | :heavy_check_mark: | The request object to use for the request. |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrDeleteProtected | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
delete_keys
Example Usage
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request | models.DeleteKeysRequestBody | :heavy_check_mark: | The request object to use for the request. |
retries | Optional[utils.RetryConfig] | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
Response
Errors
Error Type | Status Code | Content Type |
---|---|---|
models.ErrBadRequest | 400 | application/json |
models.ErrUnauthorized | 401 | application/json |
models.ErrForbidden | 403 | application/json |
models.ErrNotFound | 404 | application/json |
models.ErrConflict | 409 | application/json |
models.ErrTooManyRequests | 429 | application/json |
models.ErrInternalServerError | 500 | application/json |
models.SDKError | 4XX, 5XX | */* |
Was this page helpful?