Secret Management Service
This is a service that provides secret management facilities
Version: 1.0.0
BasePath:/v1/sms/
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html
Access
- APIKey KeyParamName:token KeyInQuery:false KeyInHeader:true
[ Jump to Models ]
Table of Contents
Up
delete /domain/{domainName}
Deletes a domain by name (domainDomainNameDelete)
Deletes a domain with provided name
Path parameters
domainName (required)
Path Parameter — Name of the domain
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful Deletion
404
Invalid Path or Path not found
Add a new domain (domainPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"uuid" : "uuid"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Successful Creation
Domain
400
Invalid input
500
Internal Server Error
Login with username and password (loginPost)
Operations related to logging in via username and Password
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Return type
Example data
Content-Type: application/json
{
"ttl" : 0,
"token" : "token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful Login returns a token
inline_response_200
404
Invalid Username or Password
Up
get /domain/{domainName}/secret
List secret Names in this domain (domainDomainNameSecretGet)
Gets all secret names in this domain
Path parameters
domainName (required)
Path Parameter — Name of the domain in which to look at
Return type
Example data
Content-Type: application/json
"{\"secretnames\":[\"secretname1\",\"secretname2\",\"secretname3\"]}"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200_2
404
Invalid Path or Path not found
Up
post /domain/{domainName}/secret
Add a new secret (domainDomainNameSecretPost)
Path parameters
domainName (required)
Path Parameter — Name of the domain
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Successful Creation
404
Invalid Path or Path not found
Up
delete /domain/{domainName}/secret/{secretName}
Deletes a Secret (domainDomainNameSecretSecretNameDelete)
Path parameters
secretName (required)
Path Parameter — Name of Secret to Delete
domainName (required)
Path Parameter — Path to the SecretDomain which contains the Secret
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful Deletion
404
Invalid Path or Path not found
Up
get /domain/{domainName}/secret/{secretName}
Find Secret by Name (domainDomainNameSecretSecretNameGet)
Returns a single secret
Path parameters
domainName (required)
Path Parameter — Name of the domain in which to look at
secretName (required)
Path Parameter — Name of the secret which is needed
Return type
Example data
Content-Type: application/json
{
"values" : {
"name" : "john",
"Age" : 40,
"admin" : true
},
"name" : "name"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
Secret
404
Invalid Path or Path not found
Get backend status (statusGet)
Gets current backend status. This API is used only by quorum clients
Return type
Example data
Content-Type: application/json
{
"sealstatus" : "sealstatus"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful operation
inline_response_200_1
404
Invalid Path or Path not found
Unseal backend (unsealPost)
Sends unseal shard to unseal if backend is sealed
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Submitted unseal key
404
Invalid Path or Path not found
[ Jump to Methods ]
Table of Contents
Credential - Domain - Secret - body - inline_response_200 - inline_response_200_1 - inline_response_200_2 -
username (optional)
password (optional)
uuid (optional)
String Optional value provided by user. If user does not provide, server will auto generate
name (optional)
String Name of the secret domain under which all secrets will be stored
name (optional)
values (optional)
unsealshard (optional)
String Unseal shard that will be used along with other shards to unseal backend
token (optional)
ttl (optional)
Integer ttl of returned token in seconds