Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Files API

The Files API from Extole — 4 operation(s) for files.

Extole Files API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Files. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

7 operations 4 paths 6 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Files API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Files 7
GET
/v6/files
List file assets
listFiles 6 params → 200400401402403415429
POST
/v6/files
Upload a file asset
createFile body → 200400401402403415429
GET
/v6/files/{fileId}
Get a file asset
getFile 1 param → 200400401402403404415429
PUT
/v6/files/{fileId}
Update a file asset
updateFile 1 param body → 200400401402403404415429
DELETE
/v6/files/{fileId}
Delete a file asset
deleteFile 1 param → 200400401402403404415429
GET
/v6/files/{fileId}/download
Download a file asset
downloadFile 3 params → 200400401402403404415429
POST
/v6/files/{fileId}/expire
Expire a file asset
expireFile 1 param → 200400401402403404415429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are RestExceptionResponse (5 properties), FileAssetMetadata (3 properties), FileAttributes (2 properties), FileAssetRequest (2 properties). Each schema is shown below with its type and property counts.

FileAssetUpdateRequest
object
Body of a PUT /v6/files/{fileId} request.
2 properties
FileInputStreamRequest
object
2 properties 2 required
FileAssetRequest
object
2 properties 2 required
FileAssetMetadata
object
3 properties
FileAttributes
object
2 properties
RestExceptionResponse
object
Represents the API error response
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-files-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API