Supercheck LogoSupercheck
Trigger Keys

Update a trigger key

Enable, disable, or rename a trigger key.

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

Authorization

bearerAuth
AuthorizationBearer <token>

CLI token (sck_live_*) for full API access, or trigger key (sck_trigger_* / legacy job_*) for job trigger endpoint only.

In: header

Path Parameters

id*string

Job ID

Formatuuid
keyId*string

Trigger key ID

Formatuuid

Request Body

application/json

enabled?boolean
name?string

Response Body

application/json

application/json

application/json

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 '{}'
{
  "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",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "Unauthorized"
}
{
  "error": "Not found"
}