Create a Secret Manager instance

You can create a Secret Manager instance within your space.

During creation, you must define the instance name and choose its network visibility.

Once the Secret Manager instance has been created, you can connect to it to store and manage your secrets.

Permissions

info

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

• secrets.instance.create

Choosing the network type

The choice between a Private and a Public network determines who can access your Secret Manager instance:

• Private (INTERNAL): your instance is only accessible within the internal Numspot network. Only your other resources present in the same network can connect to it. This option is recommended for production environments, in particular SecNumCloud environments. To access it securely, you can use a bastion VM (Virtual Machine) and a Numspot VPN (Virtual Private Network).

• Public (EXTERNAL): your instance is accessible from the Internet. Anyone with the administration token can connect to it, wherever they are. This option is suitable for development, testing or environments where network security is not critical.

Recommendation: To guarantee the security of your secrets in production, always favor the Private network.

API

The POST /secrets/spaces/{spaceId}/instances request lets you create and launch a Secret Manager instance. The instance is in the CREATING and then PENDING state until it is created, then moves to the RUNNING state.

Choosing the network type:

• Public: specify "visibility": "EXTERNAL"
• Private: specify "visibility": "INTERNAL"

Example request

{
  "name": "my-secret-manager",
  "visibility": "EXTERNAL"
}

Example response

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

View the full specification