GuidesAPI Reference
API Reference

Publishes a data blob or copies an existing blob.

Persists the data blob up to 192 MB. When the operation completes successfully, there is no guarantee that the data blob will be immediately available, although in most cases, it will be. To check if the data blob is available, use the ´HEAD´ method. The maximum key length is 450 characters.

Path Params
string
required

The ID of the parent layer for this blob.

string
required
length between 1 and 450

The key identifies a specific blob so that you can get that blob's contents. Key can only contain allowed characters: a-zA-Z0-9.[]=(){}/_-`.

Query Params
string

Copy an existing object, instead of uploading a new one. If this parameter is present, the request payload must be empty.

Body Params

Request body. Must be empty when copying an object using the source parameter.

Headers
int64

This header relates to upload only. Size of the entity-body, in bytes. For more information, see RFC 7230, section 3.3.2: Content-Length.

string

This header relates to upload only. A standard MIME type describing the format of the blob data. For more information, see RFC 2616, section 14.17: Content-Type. The value of this header must match the content type specified in the contentType field when the multipart upload was initialized, and this content type must also match the content type specified in the layer's configuration.

string

Content-encoding of the object. This header is optional. For more information, see RFC 2616, section 14.11: Content-Encoding.

string

This header can be used as a data integrity check to verify that the data received by the server is the same data that was originally sent by the client. This header specifies the lowercase Hex encoded 32-bit CRC32C checksum of the object or 128-bit MD5 digest or 160-bit SHA1 digest or 256-bit SHA256 digest. You can choose one of the following Secure Hash Algorithms (SHA) or Cyclic Redundancy Check (CRC) checksum algorithms to calculate the digest value:

  • CRC-32C
  • MD5
  • SHA1
  • SHA256

Value of the header is a combination algorithm name and digest in following format: "Algorithm:Digest". If the digest values calculated on the client side doesn't match to the digest on the server side, server generates Bad Request error.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json