FIfiles
secrets
Secrets

Update Secret

Changed on

Update Secret

patch/secrets/{id}

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/secrets/{id}
  • Auth
    none declared

Path parameters

idinteger required

Secret ID.

Request body multipart/form-data

namestring

Secret name.

descriptionstring

Internal description for your reference.

secret_type'basic' | 'token' | 'headers' | 'certificate' | 'key_value'

Secret type.

metadataobject

Non-secret metadata for the Secret type.

Example request

{
  "name": "Production API token",
  "description": "Used by production API integrations.",
  "secret_type": "token",
  "metadata": {
    "key": "example value"
  }
}

Response

The Secrets object.

idinteger

Secret ID.

workspace_idinteger

Workspace ID. 0 means the default workspace.

namestring

Secret name.

descriptionstring

Internal description for your reference.

secret_type'basic' | 'token' | 'headers' | 'certificate' | 'key_value'

Secret type.

metadataobject

Non-secret metadata for the Secret type.

value_field_namesstring[]

Names of configured secret value fields. Secret values are never returned.

created_atstring date-time

Secret create date/time.

updated_atstring date-time

Secret update date/time.

Example response

{
  "id": 1,
  "name": "Production API token",
  "description": "Used by production API integrations.",
  "secret_type": "token",
  "metadata": {
    "key": "example value"
  },
  "value_field_names": [
    "example"
  ],
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Changes