Secrets API

Endpoint Index

Action	Endpoint
Fetch a Secret	GET /resource/{tenantLocator}/secrets/{name}
Create a Secret	POST /resource/{tenantLocator}/secrets
Update a Secret	PATCH /resource/{tenantLocator}/secrets/{name}
Delete Secret	DELETE /resource/{tenantLocator}/secrets/{name}

Fetch a Secret

fetchSecret

GET /resource/{tenantLocator}/secrets/{name}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required
byStaticName	query	boolean?	optional
date	query	datetime?	optional

Response:SecretResponse
Security Group:secrets   Permission:read

SecretResponse

required
resource BasicResourceResponse
secret object

Create a Secret

createSecret

POST /resource/{tenantLocator}/secrets

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:SecretCreateRequest
Response:SecretResponse
Security Group:secrets   Permission:write

SecretCreateRequest

required
staticName string
name string
secret map<string,object>

Update a Secret

updateSecret

PATCH /resource/{tenantLocator}/secrets/{name}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required

Request:map<string,object>
Response:SecretResponse
Security Group:secrets   Permission:write

Delete Secret

deleteSecret

DELETE /resource/{tenantLocator}/secrets/{name}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
name	path	string	required

Response:void
Security Group:secrets   Permission:write