Skip to main content

Data (S6)

The Ionburst Cloud Data 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 data processing 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 data in the event of a GET.

Check Data

Checks if an S6 object identifier is present, i.e. already uploaded to Ionburst Cloud.

URL : /api/data/$OBJECT-ID

Method : HEAD

Authentication Required : YES

Example Bodies

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

Success Responses

Condition : Data object exists.

Code : 200 OK

Headers:

< HTTP/1.1 200 OK
< Date: Mon, 16 May 2022 11:29:38 GMT
< Server: $SERVER
< x-orginal-length: 1234

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

Upload Data

Uploads data; a file or object, to Ionburst Cloud. Please note, the Upload Data method is limited to a maximum body object size of 50MB.

URL : /api/data/$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/$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 : Data 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 Data

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

URL : /api/data/$OBJECT-ID

Method : GET

Authentication Required : YES

Example Bodies

Accept : application/octet-stream

> GET /api/data/$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 : 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 Data

Deletes data; a file or object, from Ionburst Cloud.

URL : /api/data/$OBJECT-ID

Method : DELETE

Authentication Required : YES

Example Bodies

Accept : application/octet-stream

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

Success Responses

Condition : Data 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