support-ticket-analyzer / backend /docs /docs-cloud-reference-api-api-key-deleteapikey.txt
tomeese's picture
Claude Opus 5.5
Rebrand as Halyard Cloud ticket analyzer; add triage, replies and personas
d0954af
Raw History Blame Contribute Delete
4.86 kB
TITLE: Delete an API key
URL:
============================================================
Delete an API key
Delete an API key
publicOauth2 delete:api-key
API key client ID
Successfully deleted the API key.
Access token is missing or invalid
ID uniquely identifying the request/response cycle.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.
Permission denied
ID uniquely identifying the request/response cycle.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.
Resource not found
ID uniquely identifying the request/response cycle.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.
Internal Server Error
ID uniquely identifying the request/response cycle.
RFC 9457 Problem Details for HTTP APIs.
Provides a standardized format for conveying error details in HTTP responses.
URN-based error type identifiers following the pattern:
urn:halyard:errors:{category}:{specific}
Resource information (cluster, database, organization, etc.) is provided
in the ProblemDetails context field, not in the URN.
A short, human-readable summary of the problem type
The HTTP status code
A human-readable explanation specific to this occurrence
A URI reference that identifies the specific occurrence
object
object
object
Context for resource-related errors (not-found, already-exists)
Type of resource (e.g., cluster, database, organization)
Identifier of the resource
Structured context for validation errors
JSON Pointer paths to missing required fields
Details about invalid field values
JSON Pointer path to the invalid field
URN identifying the specific validation error type
An optional human-readable description of the validation error
Developer-friendly message explaining the error.
Deprecated: Use ‘detail’ field instead.