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

200
400
401
403
500

Content type

application/json

{"cursor": "string",
"data": [{"action": "string",
"created": "2019-08-24T14:15:22Z",
"id": "string",
"ipaddress": "string",
"message": "string",
"path": "string",
"principal": "string",
"principalItemId": "string",
"status": 0,
"tenant": "string",
"tenantName": "string"
}
],
"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

400
401
403
500

Content type

application/json

{"code": 0,
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"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

200
400
401
500

Content type

application/json

{"cursor": "string",
"data": [{"TTL": 0,
"accessed": "string",
"clientId": "string",
"clientSecret": "string",
"created": "string",
"createdBy": "string",
"description": "string",
"expiredAt": "string",
"id": "string",
"role": "string",
"status": "string",
"url": true,
"urlExpires": "string",
"urlPath": "string",
"urlTTL": 0,
"usedCount": 0,
"usesLimit": 0
}
],
"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

description	string
role required	string Name of role to assign to client
ttl	integer <int64> TTL expiration in seconds
url	boolean
urlTTL	integer <int64>
usesLimit	integer <int64> Uses the number of times the client credential can be read. if set to 0, it can be used infinitely. default is 0.