Client API: Mail: Api keys
The 3 Client API operations for api keys.
Part of Mail.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/client/platform-mail/{tenant_id}/api-keys |
List API keys |
| POST | /api/v1/client/platform-mail/{tenant_id}/api-keys |
Create API key |
| DELETE | /api/v1/client/platform-mail/{tenant_id}/api-keys/{key_id} |
Revoke API key |
List API keys
Section titled List API keysGET /api/v1/client/platform-mail/{tenant_id}/api-keys
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
tenant_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Create API key
Section titled Create API keyPOST /api/v1/client/platform-mail/{tenant_id}/api-keys
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
tenant_id |
path | integer | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
label |
string | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Revoke API key
Section titled Revoke API keyDELETE /api/v1/client/platform-mail/{tenant_id}/api-keys/{key_id}
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
key_id |
path | integer | yes |
tenant_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |