Skip to main content

Secrets (NKV)

The Ionburst Cloud Secrets API methods offer two styles of use. There is a single request for POST(PUT), GET and DELETE where an Ionburst Cloud operation is initiated and no response is generated until that operation completes.

There is also a deferred mode where a POST or GET is initiated, but does not wait for the processing of the secret to complete. In the event of a deferred request, a token is returned that can be used to query status of the operation, or fetch the secret in the event of a GET.

Upload Secret#

Uploads a secret; a string, file, or object, to Ionburst Cloud. Please note, the Upload Secrets method is limited to a maximum body object size of 10KB.

URL : /api/secrets/$OBJECT-ID

Method : POST

Authentication Required : YES

Example Bodies#

Content-Type : application/octet-stream

Query String : classstr - set to one of the values returned by the Classification method, to have Ionburst Cloud secure the secret according to that policy. If no policy selection is made, Ionburst Cloud will use a default.

> POST /api/secrets/$OBJECT-ID?classstr=unclassified HTTP/2
> Host: api.example.ionburst.cloud
> User-Agent: $USER-AGENT
> Content-Type: application/octet-stream
> Authorization: Bearer $BEARER-TOKEN
> Accept: */*
> Content-Length: $CONTENT-LENGTH

Success Responses#

Condition : Secret successfully processed.

Code : 200 OK

Content :

{
"success": true,
"status": 200,
"message": "Put completed successfully",
"activityToken": "658dc1cf-8d1f-489f-9c57-d5ffebd382ff"
}

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Forbidden HTTP Request

Code : 403 Forbidden

Condition : Conflict

Code : 409 Conflict

Content :

{
"success": false,
"status": 409,
"message": "$OBJECT-ID already exists in metadata store",
"activityToken": "db5b4558-ca33-416d-8627-c7bdd5ab5e25"
}

Condition : Payload Too Large

Code : 413 Bad Request

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Download Secret#

Downloads and returns secret; a string, file, or object, from Ionburst Cloud.

URL : /api/secrets/$OBJECT-ID

Method : GET

Authentication Required : YES

Example Bodies#

Accept : application/octet-stream

> GET /api/secrets/$OBJECT-ID HTTP/2
> Host: api.example.ionburst.cloud
> User-Agent: $USER-AGENT
> Accept: application/octet-stream
> Authorization: Bearer $BEARER-TOKEN

Success Responses#

Condition : Secret successfully processed.

Code : 200 OK

Content : Returned secret.

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Forbidden HTTP Request

Code : 403 Forbidden

Condition : Not Found

Code : 404 Not Found

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Delete Secret#

Deletes a secret; a string, file, or object, from Ionburst Cloud.

URL : /api/secrets/$OBJECT-ID

Method : DELETE

Authentication Required : YES

Example Bodies#

Accept : application/octet-stream

> DELETE /api/secrets/$OBJECT-ID HTTP/2
> Host: api.example.ionburst.cloud
> User-Agent: $USER-AGENT
> Authorization: Bearer $BEARER-TOKEN
> Content-Length: 0

Success Responses#

Condition : Secret successfully deleted (initiated).

Code : 200 OK

Content :

{
"success": true,
"status": 200,
"message": "Delete completed successfully",
"activityToken": "99c8dabe-b67e-4369-8046-7cc41d21af2a"
}

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Forbidden HTTP Request

Code : 403 Forbidden

Condition : Not Found

Code : 404 Not Found

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error