Documentation Powered by ReDoc

DevOps Vault API (1.0.0)

Download OpenAPI specification:Download

The purpose of this application is to provide a simple service for storing and getting secrets

Authentication

Bearer

Security Scheme Type API Key
Header parameter name: Authorization

Audit

Find Audit Records

Find audit records based on search critera.

Authorizations:
Bearer ([])
query Parameters
principal
string

Security principal name

startDate
string <date-time>

The start date to find audits from

endDate
string <date-time>

The end date to find audits to

action
string

The audit action

path
string

The secret path

cursor
string

The cursor for pagination

limit
integer <int64>

The number of results to return

Responses

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "data":
    [
    ],
  • "length": 0,
  • "limit": 0
}

Download Audit Records

Download a zip of audit records for a time range

Authorizations:
Bearer
query Parameters
startDate
required
string

The start date to find audits from

endDate
required
string

The end date to find audits to

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "errors":
    {
    },
  • "message": "string"
}

Clients

Search for Client Credentials

Search for one or more client credentials associated with a particular role.

Authorizations:
Bearer ([])
query Parameters
role
required
string

Role name associated with client credentials

limit
integer <int64>

The maximum number of results per cursor

cursor
string

Cursor to next batch of results

Responses

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "data":
    [
    ],
  • "length": 0,
  • "limit": 0
}

Create a Client Credential

Request a new client credential for a role and get back the client id and secret key.

Authorizations:
Bearer ([])
Request Body schema: application/json
role
required
string

Name of role to assign to client

url
boolean
urlTTL
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "role": "string",
  • "url": true,
  • "urlTTL": 0
}

Response samples

Content type
application/json
{
  • "accessed": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "created": "string",
  • "createdBy": "string",
  • "id": "string",
  • "role": "string",
  • "url": true,
  • "urlPath": "string",
  • "urlTTL": 0
}

Delete a Client Credential

Delete a client credential by its unique client id.

Authorizations:
Bearer ([])
path Parameters
clientId
required
string

ClientId property of the client credentials

query Parameters
force
boolean

Delete immediately

Responses