Types
ApiKey
ApiKey type {
id: Str?,
name: Str?,
created_at: Str?
}
CreateApiKeyRequest
CreateApiKeyRequest type {
name: Str,
permission: "full_access" | "sending_access"?,
domain_id: Str?
}
CreateApiKeyResponse
CreateApiKeyResponse type {
id: Str?,
token: Str?
}
DELETEApiKeysApiKeyIdRequest
DELETEApiKeysApiKeyIdRequest type {
api-key-id: Str
}
DELETEApiKeysApiKeyIdResponse
GETApiKeysRequest
GETApiKeysResponse
GETApiKeysResponse type {
data: Vec?
}
ListApiKeysResponse
ListApiKeysResponse type {
data: Vec?
}
POSTApiKeysRequest
POSTApiKeysRequest type {
name: Str,
permission: "full_access" | "sending_access"?,
domain_id: Str?
}
POSTApiKeysResponse
POSTApiKeysResponse type {
id: Str?,
token: Str?
}
Functions
create-new-api-key
fn (request: POSTApiKeysRequest): POSTApiKeysResponse
POST /api-keys - Create a new API key
remove-existing-api-key
fn (request: DELETEApiKeysApiKeyIdRequest): DELETEApiKeysApiKeyIdResponse
DELETE /api-keys/{api_key_id} - Remove an existing API key
retrieve-list-api-keys
fn (request: GETApiKeysRequest): GETApiKeysResponse
GET /api-keys - Retrieve a list of API keys