Skip to main content

Deferred Requests

The deferred request style allows multiple queries to store or fetch data and secrets from Ionburst Cloud. When a deferred request is started the response contains a deferred token which is used in later deferred style queries. A deferred token has to be used within 30 minutes or else the result of the request is lost.

Data#

Upload Data (Deferred)#

Uploads data; a file or object, as a deferred request to Ionburst Cloud, but does not wait for the processing of the data to complete. The status can of the request can be queried via the Check Deferred Request method. Please note, the Upload Data method is limited to a maximum body object size of 50MB.

URL : /api/data/deferred/start/$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 data according to that policy. If no policy selection is made, Ionburst Cloud will use a default.

> POST /api/data/deferred/start/$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 : Deferred request successfully processed.

Code : 200 OK

Content :

{
"DeferredToken": "bebc8ae3-c0bb-4ae0-9c55-22953cf158a4"
}

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Download Data (Deferred)#

Initiates the retrieval of data; a file or object, as a deferred request from Ionburst Cloud, but does not wait for the processing of the data to complete. The status can of the request can be queried via the Check Deferred Request method. The returned data can be retrieved by the Fetch Data (Deferred) method.

URL : /api/data/deferred/start/$OBJECT-ID

Method : GET

Authentication Required : YES

Example Bodies#

Accept : application/octet-stream

> GET /api/data/deferred/start/$OBJECT-ID HTTP/2
> Host: api.example.ionburst.cloud
> User-Agent: $USER-AGENT
> Accept: */*
> Authorization: Bearer $BEARER-TOKEN

Success Responses#

Condition : Data successfully processed.

Code : 200 OK

Content :

{
"DeferredToken": "bebc8ae3-c0bb-4ae0-9c55-22953cf158a4"
}

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Check Deferred Request (Data)#

Check the status of a deferred request ID.

URL : /api/data/deferred/check/$DEFERRED-TOKEN

Method : GET

Authentication Required : YES

Example Bodies#

Accept : application/json

> GET /api/data/deferred/check/$OBJECT-ID HTTP/2
> Host: api.example.ionburst.cloud
> User-Agent: $USER-AGENT
> Accept: application/json
> Authorization: Bearer $BEARER-TOKEN

Success Responses#

Condition : Request successfully processed; the status is returned in the content body.

Code : 200 OK

Content :

{
"success": true,
"status": 200,
"message": "The deferred POST workflow has completed",
"activityToken": "de155163-2753-4041-889a-8c356f7fb8ae"
}

Condition : Data processing has not completed.

Code : 202 Accepted

Content :

Deferred GET request is still processing

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Not Found

Code : 404 Not Found

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Fetch Data (Deferred)#

Downloads and returns data; a file or object, from a deferred GET from Ionburst Cloud.

URL : /api/data/deferred/fetch/$DEFERRED-TOKEN

Method : GET

Authentication Required : YES

Example Bodies#

Accept : application/octet-stream

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

Success Responses#

Condition : Data successfully processed.

Code : 200 OK

Content : Returned object.

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Not Found

Code : 404 Not Found

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Secrets#

Upload Secret (Deferred)#

Uploads a secret; a string, file, or object, as a deferred request to Ionburst Cloud, but does not wait for the processing of the secret to complete. The status can of the request can be queried via the Check Deferred Request method. Please note, the Upload Secret method is limited to a maximum body object size of 10KB.

URL : /api/secrets/deferred/start/$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/deferred/start/$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 : Deferred request successfully processed.

Code : 200 OK

Content :

{
"DeferredToken": "bebc8ae3-c0bb-4ae0-9c55-22953cf158a4"
}

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Download Secret (Deferred)#

Initiates the retrieval of secret; a string, file, or object, as a deferred request from Ionburst Cloud, but does not wait for the processing of the secret to complete. The status can of the request can be queried via the Check Deferred Request method. The returned secret can be retrieved by the Fetch Secret (Deferred) method.

URL : /api/secrets/deferred/start/$OBJECT-ID

Method : GET

Authentication Required : YES

Example Bodies#

Accept : application/octet-stream

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

Success Responses#

Condition : Secret successfully processed.

Code : 200 OK

Content :

{
"DeferredToken": "bebc8ae3-c0bb-4ae0-9c55-22953cf158a4"
}

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Check Deferred Request (Secrets)#

Check the status of a deferred request ID.

URL : /api/secrets/deferred/check/$DEFERRED-TOKEN

Method : GET

Authentication Required : YES

Example Bodies#

Accept : application/json

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

Success Responses#

Condition : Request successfully processed; the status is returned in the content body.

Code : 200 OK

Content :

{
"success": true,
"status": 200,
"message": "The deferred POST workflow has completed",
"activityToken": "de155163-2753-4041-889a-8c356f7fb8ae"
}

Condition : Secret processing has not completed.

Code : 202 Accepted

Content :

Deferred GET request is still processing

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Not Found

Code : 404 Not Found

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error

Fetch Secret (Deferred)#

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

URL : /api/secrets/deferred/fetch/$DEFERRED-TOKEN

Method : GET

Authentication Required : YES

Example Bodies#

Accept : application/octet-stream

> GET /api/secrets/deferred/fetch/$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 retrieved.

Code : 200 OK

Content : Returned secret.

Error Responses#

Condition : Bad HTTP Request

Code : 400 Bad Request

Condition : Unauthorized Request

Code : 401 Unauthorized

Condition : Not Found

Code : 404 Not Found

Condition : Too Many Requests

Code : 429 Bad Request

Condition : Unspecified Server Error

Code : 500 Internal Server Error