Secrets

Download schema

Secret management endpoints

List secrets with components

GET

https://app.monad.com/api

/v2/{organization_id}/secrets

Authorization (header)

x-api-key (header)

Required Permissions: secrets:read

Lists all secrets for the specified organization including inputs and outputs that use them

List secrets with components › path Parameters

organization_id

string · required

Organization ID

List secrets with components › query Parameters

limit

integer

Limit number of results

offset

integer

Offset results

List secrets with components › Responses

models.SecretWithComponentsList

models.Pagination

models.SecretWithComponents[]

GET/v2/{organization_id}/secrets

curl https://app.monad.com/api/v2/:organization_id/secrets \
  --header 'Authorization: <api-key>'

Example Responses

{
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "secrets": [
    {
      "created_at": "created_at",
      "description": "description",
      "enrichments": [
        {
          "definition_ref": {
            "house": "house",
            "name": "name"
          },
          "id": "id",
          "kind": "transform",
          "name": "name",
          "type": "type"
        }
      ],
      "id": "id",
      "inputs": [
        {
          "definition_ref": {
            "house": "house",
            "name": "name"
          },
          "id": "id",
          "kind": "transform",
          "name": "name",
          "type": "type"
        }
      ],
      "name": "name",
      "organization_id": "organization_id",
      "outputs": [
        {
          "definition_ref": {
            "house": "house",
            "name": "name"
          },
          "id": "id",
          "kind": "transform",
          "name": "name",
          "type": "type"
        }
      ],
      "transforms": [
        {
          "definition_ref": {
            "house": "house",
            "name": "name"
          },
          "id": "id",
          "kind": "transform",
          "name": "name",
          "type": "type"
        }
      ],
      "updated_at": "updated_at",
      "value": "value"
    }
  ]
}

json

application/json

Create secret

POST

https://app.monad.com/api

/v2/{organization_id}/secrets

Authorization (header)

x-api-key (header)

Required Permissions: secrets:write

Creates a new secret for the specified organization

Create secret › path Parameters

organization_id

string · required

Organization ID

Create secret › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Create secret › Responses

Created

A secret object without sensitive data

routesV2.SecretResponse

created_at

string

description

string

id

string

name

string

organization_id

string

updated_at

string

Get secret with components

GET

https://app.monad.com/api

/v2/{organization_id}/secrets/{secret_id}

Authorization (header)

x-api-key (header)

Required Permissions: secrets:read

Gets a specific secret by ID including inputs and outputs that use it

Get secret with components › path Parameters

organization_id

string · required

Organization ID

secret_id

string · required

Secret ID

Get secret with components › Responses

models.SecretWithComponents

created_at

string

When the secret was created

description

string

The user set Description of the secret

models.ComponentReference[]

id

string

The ID of the secret

models.ComponentReference[]

name

string

The user set Name of the secret

organization_id

string

The OrganizationID the secret belongs to

models.ComponentReference[]

updated_at

string

When the secret was updated

value

string

The value of the secret. This will never be returned to the client but can be used to set new values when used in a request payload.

GET/v2/{organization_id}/secrets/{secret_id}

curl https://app.monad.com/api/v2/:organization_id/secrets/:secret_id \
  --header 'Authorization: <api-key>'

Example Responses

{
  "created_at": "created_at",
  "description": "description",
  "enrichments": [
    {
      "definition_ref": {
        "house": "house",
        "name": "name"
      },
      "id": "id",
      "kind": "transform",
      "name": "name",
      "type": "type"
    }
  ],
  "id": "id",
  "inputs": [
    {
      "definition_ref": {
        "house": "house",
        "name": "name"
      },
      "id": "id",
      "kind": "transform",
      "name": "name",
      "type": "type"
    }
  ],
  "name": "name",
  "organization_id": "organization_id",
  "outputs": [
    {
      "definition_ref": {
        "house": "house",
        "name": "name"
      },
      "id": "id",
      "kind": "transform",
      "name": "name",
      "type": "type"
    }
  ],
  "transforms": [
    {
      "definition_ref": {
        "house": "house",
        "name": "name"
      },
      "id": "id",
      "kind": "transform",
      "name": "name",
      "type": "type"
    }
  ],
  "updated_at": "updated_at",
  "value": "value"
}

json

application/json

Delete secret

DELETE

https://app.monad.com/api

/v2/{organization_id}/secrets/{secret_id}

Authorization (header)

x-api-key (header)

Required Permissions: secrets:delete

Deletes a specific secret by ID

Delete secret › path Parameters

organization_id

string · required

Organization ID

secret_id

string · required

Secret ID

Delete secret › Responses

No Content

No data returned

Update secret

PATCH

https://app.monad.com/api

/v2/{organization_id}/secrets/{secret_id}

Authorization (header)

x-api-key (header)

Required Permissions: secrets:write

Updates a specific secret by ID

Update secret › path Parameters

organization_id

string · required

Organization ID

secret_id

string · required

Secret ID

Update secret › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update secret › Responses

A secret object without sensitive data

routesV2.SecretResponse

created_at

string

description

string

id

string

name

string

organization_id

string

updated_at

string

Billing Products Logs

List secrets with components

GET

https://app.monad.com/api

/v2/{organization_id}/secrets

Authorization (header)

x-api-key (header)

Required Permissions: secrets:read

Lists all secrets for the specified organization including inputs and outputs that use them

List secrets with components › path Parameters

organization_id

string · required

Organization ID

List secrets with components › query Parameters

limit

integer

Limit number of results

offset

integer

Offset results

List secrets with components › Responses

models.SecretWithComponentsList

models.Pagination

models.SecretWithComponents[]

Create secret

POST

https://app.monad.com/api

/v2/{organization_id}/secrets

Authorization (header)

x-api-key (header)

Required Permissions: secrets:write

Creates a new secret for the specified organization

Create secret › path Parameters

organization_id

string · required

Organization ID

Create secret › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Create secret › Responses

Created

A secret object without sensitive data

routesV2.SecretResponse

created_at

string

description

string

id

string

name

string

organization_id

string

updated_at

string

Get secret with components

GET

https://app.monad.com/api

/v2/{organization_id}/secrets/{secret_id}

Authorization (header)

x-api-key (header)

Required Permissions: secrets:read

Gets a specific secret by ID including inputs and outputs that use it

Get secret with components › path Parameters

organization_id

string · required

Organization ID

secret_id

string · required

Secret ID

Get secret with components › Responses

models.SecretWithComponents

created_at

string

When the secret was created

description

string

The user set Description of the secret

models.ComponentReference[]

id

string

The ID of the secret

models.ComponentReference[]

name

string

The user set Name of the secret

organization_id

string

The OrganizationID the secret belongs to

models.ComponentReference[]

updated_at

string

When the secret was updated

value

string

The value of the secret. This will never be returned to the client but can be used to set new values when used in a request payload.

Delete secret

DELETE

https://app.monad.com/api

/v2/{organization_id}/secrets/{secret_id}

Authorization (header)

x-api-key (header)

Required Permissions: secrets:delete

Deletes a specific secret by ID

Delete secret › path Parameters

organization_id

string · required

Organization ID

secret_id

string · required

Secret ID

Delete secret › Responses

No Content

No data returned

Update secret

PATCH

https://app.monad.com/api

/v2/{organization_id}/secrets/{secret_id}

Authorization (header)

x-api-key (header)

Required Permissions: secrets:write

Updates a specific secret by ID

Update secret › path Parameters

organization_id

string · required

Organization ID

secret_id

string · required

Secret ID

Update secret › Request Body

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

Update secret › Responses

A secret object without sensitive data

routesV2.SecretResponse

created_at

string

description

string

id

string

name

string

organization_id

string

updated_at

string