Secrets Manager API

The Secrets Manager API allows you to programmatically create, retrieve, update, and delete secrets stored in the NetActuate platform. Use this API to integrate secret management into your automation workflows, CI/CD pipelines, and infrastructure-as-code tooling.

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer <your-api-key>

Base URL

https://api.netactuate.com/v3

---

List Secrets

Retrieve a list of all secrets in your account.

Request:

GET /secrets

Response:

{
  "secrets": [
    {
      "id": 1,
      "name": "db-password",
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "api-key",
      "created_at": "2026-02-01T14:00:00Z",
      "updated_at": "2026-02-01T14:00:00Z"
    }
  ]
}

Note: Secret values are never returned in list responses for security.

---

Get a Secret

Retrieve a single secret by ID.

Request:

GET /secrets/{id}

Parameters:

Parameter	Type	Description
id	integer	The secret ID

Response:

{
  "id": 1,
  "name": "db-password",
  "value": "s3cur3-p4ssw0rd",
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

---

Create a Secret

Create a new secret.

Request:

POST /secrets

Body:

{
  "name": "db-password",
  "value": "s3cur3-p4ssw0rd"
}

Parameters:

Parameter	Type	Required	Description
name	string	Yes	A unique name for the secret
value	string	Yes	The secret value to store

Response:

{
  "id": 1,
  "name": "db-password",
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

---

Update a Secret

Update an existing secret's value.

Request:

PUT /secrets/{id}

Body:

{
  "value": "new-s3cur3-p4ssw0rd"
}

Parameters:

Parameter	Type	Required	Description
id	integer	Yes	The secret ID (path parameter)
value	string	Yes	The new secret value

Response:

{
  "id": 1,
  "name": "db-password",
  "updated_at": "2026-01-15T12:00:00Z"
}

---

Delete a Secret

Permanently delete a secret.

Request:

DELETE /secrets/{id}

Parameters:

Parameter	Type	Description
id	integer	The secret ID

Response:

{
  "message": "Secret deleted successfully"
}

Note: Deleting a secret does not affect VMs that have already been deployed with the secret's value. The value will remain on those VMs until they are redeployed.

---

Error Responses

Status Code	Description
400	Bad request — invalid parameters
401	Unauthorized — invalid or missing API key
404	Not found — secret does not exist
409	Conflict — a secret with that name already exists
500	Internal server error

Next Steps

• Working with Secrets — Portal-based secrets management and cloud-init integration
• API Reference — Full NetActuate API documentation