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

200

Successful audit log search response

400

bad request

401

unauthorized

403

forbidden

500

server error

get/audit
https://secretsvaultcloud.com/v1/audit

Response samples

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

Download Audit Records

Download a zip of audit records for a time range

Authorizations:
query Parameters
startDate
required
string

The start date to find audits from

endDate
required
string

The end date to find audits to

Responses

200

audit file response

400

bad request

401

unauthorized

403

forbidden

500

server error

get/download/audit
https://secretsvaultcloud.com/v1/download/audit

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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

200

no error

400

bad request

401

unauthorized

500

server error

get/clients
https://secretsvaultcloud.com/v1/clients

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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

Responses

201

no error

400

bad request

401

unauthorized

403

forbidden

500

server error

post/clients
https://secretsvaultcloud.com/v1/clients

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "role": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "created": "string",
  • "createdBy": "string",
  • "id": "string",
  • "role": "string"
}

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

204

no error

400

bad request

401

unauthorized

403

forbidden

404

not found

500

server error

delete/clients/{clientId}
https://secretsvaultcloud.com/v1/clients/{clientId}

Response samples

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

Restore a Client

Restore a client by ID.

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

ClientId property of the client credentials

Responses

204

no error

400

bad request

401

unauthorized

403

forbidden

404

not found

500

server error

get/clients/{clientId}
https://secretsvaultcloud.com/v1/clients/{clientId}

Response samples

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

Config

Get Config

Get config data.

Authorizations:
Bearer ([])

Responses

200

no error

400

bad request

401

unauthorized

403

forbidden

404

not found

500

server error

get/config
https://secretsvaultcloud.com/v1/config

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "created": "string",
  • "createdBy": "string",
  • "lastModified": "string",
  • "lastModifiedBy": "string",
  • "permissionDocument":
    [