ReferenceAPI
Connections
Connection strings and credential rotation.
AuthorizationBearer <token>
Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
projectID*string
Project id.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/projects/string/connections"{ "connections": { "direct_url": "string", "pooled_url": "string", "username": "string" }}{ "error": "string"}{ "error": "string"}{ "error": "string"}AuthorizationBearer <token>
Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
previewID*string
Preview database id.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/preview-databases/string/connections"{ "connections": { "direct_url": "string", "pooled_url": "string", "username": "string" }}{ "error": "string"}{ "error": "string"}{ "error": "string"}AuthorizationBearer <token>
Org or project-scoped API key, format capy_live_...; Clerk session tokens also accepted.
In: header
Path Parameters
projectID*string
Project id.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/projects/string/credentials/rotate"{ "job": { "attempts": 0, "claimed_at": "2019-08-24T14:15:22Z", "claimed_by": "string", "cluster_id": "string", "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "error": "string", "id": "string", "last_exit_code": 0, "last_stderr": "string", "last_stdout": "string", "locked_resource": "string", "max_attempts": 0, "organization_id": "string", "preview_database_id": "string", "project_id": "string", "retry_classification": "string", "started_at": "2019-08-24T14:15:22Z", "state": "pending", "type": "string", "updated_at": "2019-08-24T14:15:22Z" }}{ "error": "string"}{ "error": "string"}{ "error": "string"}{ "error": "string"}