Start a test bound to the exact next signing key
POST /v1/connections/{conn}/sp_key_rotations/test: Start a test bound to the exact next signing key.
POST /
Mutations require a current project administrator using a CLI credential or dashboard session; secret API keys cannot authorize them.
- Scope
connections:write- Auth
- Access token
- Since
- 1.0
Path parameters
Section titled “Path parameters”connstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”
Canonical decimal signed 64-bit generation; strings preserve precision in every client.generationstring Required
Responses
Section titled “Responses”- 200 Bound, single-use next-key test URL SPKeyRotationTest
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations/test" \ -H "Authorization: Bearer $OHAUTHCAT_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "generation": "1"}'const response = await fetch("https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations/test", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_ACCESS_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({ "generation": "1" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/sp_key_rotations/test", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_ACCESS_TOKEN']}"}, json={ "generation": "1", },)data = response.json(){ "object": "sp_key_rotation_test", "generation": "1", "test_url": "https://app.acme.com/callback", "expires_at": "2026-01-15T09:30:00Z"}