List API resource secrets

GET

/resources/api_resources/{api_id}/secrets

Retrieves a list of secrets associated with the API resource.

Authorization

API-Key

headerX-API-KEY<token>

MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>

Path Parameters

api_id*string

The unique identifier of the API resource.

Response Body

200

application/json

The API resource secrets were retrieved successfully

TypeScript Definitions

Use the response body type in TypeScript.

Returns an array. Each item has the fields below.

Secret Response: Represents a credential used by a client or API resource.

id*string

The unique identifier of the secret.

description?|

Description that explains the purpose of the secret.

expiration?|

Specifies the time at which the secret expires (in Epoch).

Formatdate-time

type*SecretTypes

Specifies the type of secret.

values

shared_secret
A shared symmetric secret value.
x509_thumbprint
An X.509 certificate identified by its thumbprint.
x509_name
An X.509 certificate identified by its subject name.
x509_issuer_name
An X.509 certificate identified by its issuer name.
x509_certificate_base64
A base64-encoded X.509 certificate.
jwk
A JSON Web Key (JWK).
jwt_assertion_shared_secret
A shared secret used for JWT-based client assertion authentication.
spiffe_id
A SPIFFE ID matched against the SVID presented by the workload. May end with a /* wildcard matching any path under the prefix.
jwt_svid_assertion
A SPIFFE ID matched against the JWT-SVID assertion presented by the workload. May end with a /* wildcard matching any path under the prefix.

creation_time*integer

Specifies the creation time of the secret (in Epoch).

Formatdate-time

last_updated*integer

Specifies the last update time of the secret (in Epoch).

Formatdate-time

secret_value*string

The secret value used to authenticate the client or API resource.

Errors

401Unauthorized

403Forbidden

curl -X GET "https://your-domain.us.monocloud.com/api/resources/api_resources/n8TniSuy4WN9ROJYNwir6/secrets" \  -H "X-API-KEY: <token>"

[  {    "id": "string",    "description": null,    "expiration": null,    "type": "shared_secret",    "creation_time": 0,    "last_updated": 0,    "secret_value": "string"  }]

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

ErrorsCopy Anchor Link

404Not Found

422Unprocessable Entity

Authorization

Path Parameters

Response Body

Errors