v1

latestOpenAPI 3.1.0Apache 2.02026-07-178042197.1 KB
Objects

Object Information

Return Flow references and other information about init or Media Objects.

head/objects/{objectId}

Path parameters

objectIdstring required

The Object identifier. The Object ID may include special characters such as / which should be URL encoded.

Query parameters

verbose_storageboolean

Include storage metadata in get_urls. When verbose_storage is false only url, presigned, and label will be included in get_urls and init_object.get_urls.

accept_get_urlsstring

A list of Object GET URL Labels, formatted for use in query string parameters

A comma separated list of labels of Object get_urls and init_object.get_urls to include in the response. Omitting accept_get_urls will result in no filtering of get_urls or init_object.get_urls. An empty accept_get_urls results in get_urls and init_object.get_urls being empty or omitted in the response. Object get_urls and init_object.get_urls with no label will only be returned if accept_get_urls is omitted. Without get_urls or init_object.get_urls, the response from the service could be substantially faster if it is not required to generate a large number of pre-signed URLs for example. Where multiple filter query parameters are provided, the returned get_urls and init_object.get_urls will match all filters.

accept_storage_idsstring

A comma separated list of storage_ids of Object get_urls and init_object.get_urls to include in the response. Omitting accept_storage_ids, or providing an empty accept_storage_ids will result in no filtering of get_urls or init_object.get_urls. Object get_urls and init_object.get_urls with no storage ID will only be returned if accept_storage_ids is omitted or empty. A full list of available storage_ids may be found at the service/storage-backends endpoint. Where multiple filter query parameters are provided, the returned get_urls and init_object.get_urls will match all filters.

presignedboolean

If set to true, only presigned URLs (i.e. those whos presigned property is true) will be returned in get_urls and init_object.get_urls. If set to false, only non-presigned URLs (i.e. those whos presigned property is false) will be returned in get_urls and init_object.get_urls. If omitted, both presigned and non-presigned URLs will be returned. If presigned is set to false, the response from the service could be substantially faster if it is not required to generate a large number of pre-signed URLs. Where multiple filter query parameters are provided, the returned get_urls and init_object.get_urls will match all filters.

flow_tag.{name}string

Filter referenced_by_flows on tag values. This option is the same as the tag.{name} query parameter on the /flows/ API endpoint.

flow_tag_exists.{name}boolean

Filter referenced_by_flows on tag names. This option is the same as the tag_exists.{name} query parameter on the /flows/ API endpoint.

pagestring

Opaque string used by backend to access a specific page of results. Clients should read the next URL from the Link header returned with responses, or use value of the returned X-Paging-NextKey header. If not supplied, the first page is accessed. Service implementations should ensure a consistent sort order is applied to pages of results.

limitinteger

Restrict the response to the specified number of results. Service implementations may specify their own default and maximum for the limit

Response

string required