Archive a file

Store a file in your Global Relay Archive.

The service won't store partial objects; if no error is returned the entire object was stored.

put/files/default/{fileKey}

Request

Base URL
https://eventfeed.api.globalrelay.com/v2
Auth
OAuth 2
Client credentials
Token URLhttps://iam-oauth2.globalrelay.com/oauth2/token
Scopesfile, write, openid
TypeScript
https://skmtc.dev/globalrelay/apis/event-archiving-api/docs/files/default/:fileKey/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fileKeystring required

The key of the file being uploaded.

Headers

Hoststring required

Server from which the request originated.

Content-Lengthstring required

Size of the body in bytes. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

Content-Typestring required

A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.

Content-Encodingstring

Specifies what content encodings have been applied to the file and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

Content-Languagestring

The language of the content.

Request body application/octet-stream

string binary required

Response

The action was successful.

Changes

No recorded changes to this operation across all 1 revision of this API.