Secret Provider API (2.17.0)

Download OpenAPI specification:Download

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for implementations of custom Secret Provider

ILM Documentation

Secret Management

Secret Management API

Update Secret

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

name required	string non-empty Name of the secret
required	BasicAuthSecretContent (object) or ApiKeySecretContent (object) or JwtTokenSecretContent (object) or PrivateKeySecretContent (object) or SecretKeySecretContent (object) or KeyStoreSecretContent (object) or KeyValueSecretContent (object) or GenericSecretContent (object) (SecretContent)
	Array of objects (RequestAttribute) Vault attributes
	Array of objects (RequestAttribute) Vault profile attributes
	Array of objects (RequestAttribute) Secret attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Metadata for the secret

Responses

Request samples

Payload

Content type

application/json

{"name": "MyServerCredentials",
"secret": {"type": "basicAuth",
"username": "admin",
"password": "string"
},
"vaultAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"vaultProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"secretAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

401
404
422
500
503

Content type

application/problem+json

{"type": "https://docs.otilm.com/problems/common/validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "One or more fields failed validation.",
"instance": "https://api.example.org/foo/bar/123",
"properties": {"property1": null,
"property2": null
},
"errorCode": "VALIDATION_FAILED",
"timestamp": "2026-01-22T15:10:20.123Z",
"correlationId": "string",
"retryable": true,
"retryAfterSeconds": 0
}

Create Secret

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

name required	string non-empty Name of the secret
required	BasicAuthSecretContent (object) or ApiKeySecretContent (object) or JwtTokenSecretContent (object) or PrivateKeySecretContent (object) or SecretKeySecretContent (object) or KeyStoreSecretContent (object) or KeyValueSecretContent (object) or GenericSecretContent (object) (SecretContent)
	Array of objects (RequestAttribute) Vault attributes
	Array of objects (RequestAttribute) Vault profile attributes
	Array of objects (RequestAttribute) Secret attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "MyServerCredentials",
"secret": {"type": "basicAuth",
"username": "admin",
"password": "string"
},
"vaultAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"vaultProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"secretAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

401
404
422
500
503

Content type

application/problem+json

{"type": "https://docs.otilm.com/problems/common/validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "One or more fields failed validation.",
"instance": "https://api.example.org/foo/bar/123",
"properties": {"property1": null,
"property2": null
},
"errorCode": "VALIDATION_FAILED",
"timestamp": "2026-01-22T15:10:20.123Z",
"correlationId": "string",
"retryable": true,
"retryAfterSeconds": 0
}

Delete Secret

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

name required	string non-empty Name of the secret
type required	string (SecretType) Enum: "basicAuth" "apiKey" "jwtToken" "privateKey" "secretKey" "keyStore" "keyValue" "generic" Secret type
	Array of objects (RequestAttribute) Vault attributes
	Array of objects (RequestAttribute) Vault profile attributes
	Array of objects (RequestAttribute) Secret attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Metadata for the secret

Responses

Request samples

Payload

Content type

application/json

{"name": "MyServerCredentials",
"type": "basicAuth",
"vaultAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"vaultProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"secretAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

401
404
500
503

Content type

application/problem+json

{"type": "https://docs.otilm.com/problems/common/validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "One or more fields failed validation.",
"instance": "https://api.example.org/foo/bar/123",
"properties": {"property1": null,
"property2": null
},
"errorCode": "VALIDATION_FAILED",
"timestamp": "2026-01-22T15:10:20.123Z",
"correlationId": "string",
"retryable": true,
"retryAfterSeconds": 0
}

Rotate Secret

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

name required	string non-empty Name of the secret
type required	string (SecretType) Enum: "basicAuth" "apiKey" "jwtToken" "privateKey" "secretKey" "keyStore" "keyValue" "generic" Secret type
	Array of objects (RequestAttribute) Vault attributes
	Array of objects (RequestAttribute) Vault profile attributes
	Array of objects (RequestAttribute) Secret attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Metadata for the secret

Responses

Request samples

Payload

Content type

application/json

{"name": "MyServerCredentials",
"type": "basicAuth",
"vaultAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"vaultProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"secretAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

401
404
422
500
503

Content type

application/problem+json

{"type": "https://docs.otilm.com/problems/common/validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "One or more fields failed validation.",
"instance": "https://api.example.org/foo/bar/123",
"properties": {"property1": null,
"property2": null
},
"errorCode": "VALIDATION_FAILED",
"timestamp": "2026-01-22T15:10:20.123Z",
"correlationId": "string",
"retryable": true,
"retryAfterSeconds": 0
}

Get Secret Content

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

query Parameters

version

string

Request Body schema: application/json
required

name required	string non-empty Name of the secret
type required	string (SecretType) Enum: "basicAuth" "apiKey" "jwtToken" "privateKey" "secretKey" "keyStore" "keyValue" "generic" Secret type
	Array of objects (RequestAttribute) Vault attributes
	Array of objects (RequestAttribute) Vault profile attributes
	Array of objects (RequestAttribute) Secret attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Metadata for the secret

Responses

Request samples

Payload

Content type

application/json

{"name": "MyServerCredentials",
"type": "basicAuth",
"vaultAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"vaultProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"secretAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"metadata": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

200
401
404
500
503

Content type

application/json

{"version": "string",
"content": {"type": "basicAuth",
"username": "admin",
"password": "string"
}
}

Get Secret Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

secretType

required

string (SecretType)

Enum: "basicAuth" "apiKey" "jwtToken" "privateKey" "secretKey" "keyStore" "keyValue" "generic"

Secret type

Responses

Response samples

200
401
404
500

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Get Rotate Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
401
404
500

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Metrics API

Connector metrics API. Connector metrics API is exposing standard Prometheus/OpenMetrics metrics that can be scraped by observability solutions and collectors.

Get metrics

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
401
404
500
503

Content type

application/openmetrics-text; version=1.0.0; charset=utf-8

# TYPE http_requests_total counter
http_requests_total{method="GET"} 42

Vault Management

Vault Management API

Check connection to Vault Instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

401
404
422
500
503

Content type

application/problem+json

{"type": "https://docs.otilm.com/problems/common/validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "One or more fields failed validation.",
"instance": "https://api.example.org/foo/bar/123",
"properties": {"property1": null,
"property2": null
},
"errorCode": "VALIDATION_FAILED",
"timestamp": "2026-01-22T15:10:20.123Z",
"correlationId": "string",
"retryable": true,
"retryAfterSeconds": 0
}

List Vault Profile Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

200
401
404
500

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

List Vault Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
401
404
500

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Health check v2

Connector Health check API. Connector returns own status and in some cases can return status of components on which it depends like database, HSM and so on.

Health check

Responses

Response samples

200
404
500
503

Content type

application/json

{"status": "UP",
"components": {"property1": {"status": "UP",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "UP",
"details": {"property1": null,
"property2": null
}
}
}
}

Health readiness check

Responses

Response samples

200
404
500
503

Content type

application/json

{"status": "UP",
"components": {"property1": {"status": "UP",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "UP",
"details": {"property1": null,
"property2": null
}
}
}
}

Health liveness check

Responses

Response samples

200
404
500
503

Content type

application/json

{"status": "UP",
"components": {"property1": {"status": "UP",
"details": {"property1": null,
"property2": null
}
},
"property2": {"status": "UP",
"details": {"property1": null,
"property2": null
}
}
}
}

Connector Info v2

Connector Information API. Each connector may have multiple functions represented by its connector interfaces. For each connector interface there is a list of implemented endpoints. These endpoints must be according the specified interface, this is validated by the core. You can also implement helper end points that are used for callbacks and other relevant operations specific to implementation.

Get Connector Info

Returns information about the connector and implemented interfaces.

Responses

Response samples

200
404
500

Content type

application/json

{"connector": {"id": "string",
"name": "string",
"version": "string",
"description": "string",
"metadata": {"property1": null,
"property2": null
}
},
"interfaces": [{"code": "info",
"version": "string",
"features": ["stateless"
]
}
]
}

Secret Provider API (2.17.0)

Secret Management

Update Secret

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Create Secret

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Secret

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Rotate Secret

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Secret Content

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Secret Attributes

Authorizations:

path Parameters

Responses

Response samples

Get Rotate Attributes

Authorizations:

Responses

Response samples

Metrics API

Get metrics

Authorizations:

Responses

Response samples

Vault Management

Check connection to Vault Instance

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Vault Profile Attributes

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Vault Attributes

Authorizations:

Responses

Response samples

Health check v2

Health check

Responses

Response samples

Health readiness check

Responses

Response samples

Health liveness check

Responses

Response samples

Connector Info v2

Get Connector Info

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required