Skip to content
localisyncDocs
Open panel

Revoke a diagnostic key

Owner/Admin only; current membership and active workspace/project are required for changes. Secrets are returned once and stored only as hashes. A lost creation response requires revocation and a new key. No customer error-list access is granted.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/distributions/{id}/diagnostic-keys/{keyId}/revoke

Operation: revokeDiagnosticKey · Download OpenAPI

Access

Section titled “Access”

Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.

sessionCookie

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session"
}

Parameters

Section titled “Parameters”
Name Location Required Description
workspaceId path Yes See constraints below.
projectId path Yes See constraints below.
id path Yes See constraints below.
keyId path Yes See constraints below.
X-CSRF-Token header Yes See constraints below.
Origin header Yes See constraints below.

workspaceId

Section titled “workspaceId”
{
  "type": "string",
  "format": "uuid"
}

projectId

Section titled “projectId”
{
  "type": "string",
  "format": "uuid"
}

id

Section titled “id”
{
  "type": "string",
  "format": "uuid"
}

keyId

Section titled “keyId”
{
  "type": "string",
  "format": "uuid"
}

X-CSRF-Token

Section titled “X-CSRF-Token”
{
  "type": "string"
}

Origin

Section titled “Origin”
{
  "type": "string",
  "format": "uri"
}

Request body

Section titled “Request body”

Required: Yes.

application/json

Section titled “application/json”

Schema reference: Version.

Field Type Required Constraints / description
version integer Yes maximum: 9007199254740991 
{
  "$ref": "#/components/schemas/Version"
}

Responses

Section titled “Responses”

200

Section titled “200”

Operation succeeded. A repeated create returns secret=null.

Response headers:

{
  "X-Request-ID": {
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

Content type: application/json Schema reference: DiagnosticKey.

Field Type Required Constraints / description
label string Yes minLength: 1; maxLength: 100
channel preview, production Yes —
id string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
version integer Yes maximum: 9007199254740991
createdAt string Yes format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
revokedAt See schema Yes — 
{
  "$ref": "#/components/schemas/DiagnosticKey"
}

400

Section titled “400”

Invalid schema or expired event.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

401

Section titled “401”

Session or diagnostic credential rejected.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

403

Section titled “403”

Insufficient role or origin/CSRF rejected.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

404

Section titled “404”

Resource is not accessible.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

409

Section titled “409”

Version or idempotency conflict.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

413

Section titled “413”

Request exceeds 32 KiB.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

429

Section titled “429”

Request or concurrency limit exceeded.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

500

Section titled “500”

Unexpected application failure.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}

503

Section titled “503”

Dependency or Collector unavailable.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" 
{
  "$ref": "#/components/schemas/Error"
}
Section titled “Related guidance”

Request errors and safe retries · Troubleshooting

Localisync byWetus

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.

Cookie policyWebsite privacy