# Secrets API reference

Source: `@socra/secret-api@0.0.1` (SecretContract).

Project-scoped write-only runtime secrets.

## API surface

Base URL: `https://secret.socra.cloud`

## Secrets

A project-owned write-only runtime secret identity.

### Resource schema

- `id` custom, required
- `project_id` custom, required
- `name` string (min length: 1; max length: 63; pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$), required
- `description` string | null, required
- `status` "active" | "disabled", required
- `latest_version` integer | null, required
- `created_at` custom, required
- `updated_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "project_id": {},
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 63,
      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "latest_version": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "created_at": {},
    "updated_at": {}
  },
  "required": [
    "id",
    "project_id",
    "name",
    "description",
    "status",
    "latest_version",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
```

### Create secret

`POST /v1/secrets`

#### Request body

- `project_id` custom, required
- `name` string (min length: 1; max length: 63; pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$), required
- `description` string | null (default: null), optional

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "project_id": {},
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 63,
      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
    },
    "description": {
      "default": null,
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "project_id",
    "name"
  ]
}
```

#### Response

- `id` custom, required
- `project_id` custom, required
- `name` string (min length: 1; max length: 63; pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$), required
- `description` string | null, required
- `status` "active" | "disabled", required
- `latest_version` integer | null, required
- `created_at` custom, required
- `updated_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "project_id": {},
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 63,
      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "latest_version": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "created_at": {},
    "updated_at": {}
  },
  "required": [
    "id",
    "project_id",
    "name",
    "description",
    "status",
    "latest_version",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
```

### List secrets

`GET /v1/secrets`

#### Query parameters

- `project_id` custom, required
- `status` "active" | "disabled", optional
- `limit` integer (min: 1; max: 100), optional
- `after` string, optional

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "project_id": {},
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "after": {
      "type": "string"
    }
  },
  "required": [
    "project_id"
  ]
}
```

#### Response

- `data` object[], required
  - `id` custom, required
  - `project_id` custom, required
  - `name` string (min length: 1; max length: 63; pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$), required
  - `description` string | null, required
  - `status` "active" | "disabled", required
  - `latest_version` integer | null, required
  - `created_at` custom, required
  - `updated_at` custom, required
- `has_more` boolean, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {},
          "project_id": {},
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 63,
            "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
          },
          "description": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "disabled"
            ]
          },
          "latest_version": {
            "anyOf": [
              {
                "type": "integer",
                "exclusiveMinimum": 0,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {},
          "updated_at": {}
        },
        "required": [
          "id",
          "project_id",
          "name",
          "description",
          "status",
          "latest_version",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "has_more": {
      "type": "boolean"
    }
  },
  "required": [
    "data",
    "has_more"
  ],
  "additionalProperties": false
}
```

### Get secret

`GET /v1/secrets/{id}`

#### Path parameters

- `id` custom, required

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
```


#### Response

- `id` custom, required
- `project_id` custom, required
- `name` string (min length: 1; max length: 63; pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$), required
- `description` string | null, required
- `status` "active" | "disabled", required
- `latest_version` integer | null, required
- `created_at` custom, required
- `updated_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "project_id": {},
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 63,
      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "latest_version": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "created_at": {},
    "updated_at": {}
  },
  "required": [
    "id",
    "project_id",
    "name",
    "description",
    "status",
    "latest_version",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
```

### Update secret

`PATCH /v1/secrets/{id}`

#### Path parameters

- `id` custom, required

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
```


#### Request body

- `description` string | null, optional
- `status` "active" | "disabled", optional

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    }
  }
}
```

#### Response

- `id` custom, required
- `project_id` custom, required
- `name` string (min length: 1; max length: 63; pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$), required
- `description` string | null, required
- `status` "active" | "disabled", required
- `latest_version` integer | null, required
- `created_at` custom, required
- `updated_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "project_id": {},
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 63,
      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "latest_version": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "created_at": {},
    "updated_at": {}
  },
  "required": [
    "id",
    "project_id",
    "name",
    "description",
    "status",
    "latest_version",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false
}
```

### Delete secret

`DELETE /v1/secrets/{id}`

#### Path parameters

- `id` custom, required

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
```


#### Response

No response body.

## Secret versions

Immutable write-only secret material metadata. Values are never returned.

### Resource schema

- `id` custom, required
- `secret_id` custom, required
- `number` integer (greater than: 0; max: 9007199254740991), required
- `status` "enabled" | "disabled", required
- `created_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "secret_id": {},
    "number": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "status": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "created_at": {}
  },
  "required": [
    "id",
    "secret_id",
    "number",
    "status",
    "created_at"
  ],
  "additionalProperties": false
}
```

### Add secret version

`POST /v1/secret-versions`

#### Request body

- `secret_id` custom, required
- `value` string (min length: 1; max length: 4096), required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "secret_id": {},
    "value": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "required": [
    "secret_id",
    "value"
  ]
}
```

#### Response

- `id` custom, required
- `secret_id` custom, required
- `number` integer (greater than: 0; max: 9007199254740991), required
- `status` "enabled" | "disabled", required
- `created_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "secret_id": {},
    "number": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "status": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "created_at": {}
  },
  "required": [
    "id",
    "secret_id",
    "number",
    "status",
    "created_at"
  ],
  "additionalProperties": false
}
```

### List secret versions

`GET /v1/secret-versions`

#### Query parameters

- `secret_id` custom, required
- `limit` integer (min: 1; max: 100), optional
- `after` string, optional

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "secret_id": {},
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "after": {
      "type": "string"
    }
  },
  "required": [
    "secret_id"
  ]
}
```

#### Response

- `data` object[], required
  - `id` custom, required
  - `secret_id` custom, required
  - `number` integer (greater than: 0; max: 9007199254740991), required
  - `status` "enabled" | "disabled", required
  - `created_at` custom, required
- `has_more` boolean, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {},
          "secret_id": {},
          "number": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "status": {
            "type": "string",
            "enum": [
              "enabled",
              "disabled"
            ]
          },
          "created_at": {}
        },
        "required": [
          "id",
          "secret_id",
          "number",
          "status",
          "created_at"
        ],
        "additionalProperties": false
      }
    },
    "has_more": {
      "type": "boolean"
    }
  },
  "required": [
    "data",
    "has_more"
  ],
  "additionalProperties": false
}
```

### Get secret version

`GET /v1/secret-versions/{id}`

#### Path parameters

- `id` custom, required

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
```


#### Response

- `id` custom, required
- `secret_id` custom, required
- `number` integer (greater than: 0; max: 9007199254740991), required
- `status` "enabled" | "disabled", required
- `created_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "secret_id": {},
    "number": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "status": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "created_at": {}
  },
  "required": [
    "id",
    "secret_id",
    "number",
    "status",
    "created_at"
  ],
  "additionalProperties": false
}
```

### Update secret version

`PATCH /v1/secret-versions/{id}`

#### Path parameters

- `id` custom, required

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
```


#### Request body

- `status` "enabled" | "disabled", required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ]
    }
  },
  "required": [
    "status"
  ]
}
```

#### Response

- `id` custom, required
- `secret_id` custom, required
- `number` integer (greater than: 0; max: 9007199254740991), required
- `status` "enabled" | "disabled", required
- `created_at` custom, required

JSON Schema:

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {},
    "secret_id": {},
    "number": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "status": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "created_at": {}
  },
  "required": [
    "id",
    "secret_id",
    "number",
    "status",
    "created_at"
  ],
  "additionalProperties": false
}
```

---

Company: Socra — Multiply Your Judgment
Canonical URL: https://cloud.socra.com/docs/secret/reference/api