Supercheck LogoSupercheck
Trigger Keys

Update a trigger key

Enable, disable, or rename a trigger key.

PATCH
/api/jobs/{id}/api-keys/{keyId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

Project-scoped CLI token (sck_live_* or sck_test_*) for documented API operations that accept bearer authentication. Interactive browser operations may require a session cookie. Trigger keys (sck_trigger_* / legacy job_*) are accepted only by job trigger endpoints.

Path Parameters

id*string

Job ID

Formatuuid
keyId*string

Trigger key ID

Formatuuid

Request Body

application/json
  1. body
enabled?boolean
name?string

Response Body

Trigger key updated

application/json
  1. response
success?boolean
apiKey?
Example Request
curl -X PATCH 'https://demo.supercheck.dev/api/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "apiKey": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "start": "string",    "enabled": true,    "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",    "expiresAt": "2019-08-24T14:15:22Z",    "lastRequest": "2019-08-24T14:15:22Z",    "createdByName": "string",    "createdByImage": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

Create a trigger key POST

Previous Page

Delete a trigger key DELETE

Next Page