support-ticket-analyzer / backend /docs /docs-cloud-reference-api-cluster-credential-getclustercredentials.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
6.79 kB
TITLE: List credentials for a cluster
URL:
============================================================
List credentials for a cluster
List credentials for a clusters.
publicOauth2 read:database
A cluster ID.
The maximum number of items to return in a single response.
Used for pagination. Must be between 1 and 100.
The number of items to skip before starting to return results.
Used for pagination. For example, to get the next 10 items after the first 10,
set offset to 10.
A collection of cluster credentials
ID uniquely identifying the request/response cycle.
Number of items returned in the result.
Number of items returned in the current result set.
Pagination metadata
Total number of items available
Maximum number of items per page
Number of items skipped before the current result set
Unique identifier for this resource within Halyard Cloud
A list of privileges granted to these credentials
The status of a user credential
Timestamp when the resource was created
Invalid input
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.
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.