{ "opencollection": "1.0.0", "info": { "name": "Aiven API Documentation Account Secrets API", "version": "v1" }, "items": [ { "info": { "name": "Secrets", "type": "folder" }, "items": [ { "info": { "name": "Trigger an access check on CMK", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks/:cmk_id/access_check", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "cmk_id", "value": "", "type": "path", "description": "CMK ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Trigger an access check on CMK" }, { "info": { "name": "List CMK accessors", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks/accessors", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List CMK accessors" }, { "info": { "name": "List CMKs", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "
Response example: { "cmks": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "provider": "aws", "resource": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012", "status": "current", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" } ] }
" }, { "info": { "name": "Create new CMK", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Request example: { "provider": "aws", "resource": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" } Response example: { "cmk": { "id": "550e8400-e29b-41d4-a716-446655440000", "provider": "aws", "resource": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012", "status": "current", "default_cmk": False," }, { "info": { "name": "Get CMK details", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks/:cmk_id", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "cmk_id", "value": "", "type": "path", "description": "CMK ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "
Response example: { "cmk": { "id": "550e8400-e29b-41d4-a716-446655440000", "provider": "aws", "resource": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012", "status": "current", "created_at": "2025-01-15T10:30:00Z", "updated_at": "2025-01-15T10:30:00Z" } }
" }, { "info": { "name": "Update CMK", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks/:cmk_id", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "cmk_id", "value": "", "type": "path", "description": "CMK ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update CMK" }, { "info": { "name": "Delete CMK", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks/:cmk_id", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "cmk_id", "value": "", "type": "path", "description": "CMK ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete CMK" }, { "info": { "name": "List services associated with a CMK", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/secrets/cmks/:cmk_id/service_associations", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "cmk_id", "value": "", "type": "path", "description": "CMK ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a list of services associated with a given CMK and their association status. Response example: { "service_associations": [ {"service_name": "my-pg-service", "status": "active"}, {"service_name": "my-kafka", "status": "activating"} ] }
" } ] } ], "bundled": true }