Skip to main content

Get the status of a Secret Manager instance

You can get the status and information of your Secret Manager instance within your space.

Permissions​

info

This action requires the following IAM (Identity and Access Management) permissions:

  • secrets.instance.get

The GET /secrets/spaces/{spaceId}/instances/{instanceId} request lets you obtain the current status of a Secret Manager instance.

Possible states​

StateDescription
PENDINGThe instance is awaiting creation
CREATINGThe instance is being created
RUNNINGThe instance is operational
DELETINGThe instance is being deleted
FAILEDCreation or the operation has failed

Example response​

{
"id": "550e8400-e29b-41d4-a716-446655440002",
"name": "my-secret-manager",
"status": {
"state": "RUNNING",
"message": "instance is healthy"
},
"version": "2.5.1",
"host": "my-secret-manager.secrets.eu-west-2.numspot.com",
"visibility": "EXTERNAL"
}

View the full specification