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

Zamzar Jobs API

Start a new conversion job plus related operations

Zamzar Jobs API is one of 6 APIs that Zamzar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 5 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 0.0.7.

Requests are made against 2 base URLs: https://api.zamzar.com/v1, https://sandbox.zamzar.com/v1.

5 operations 3 paths 8 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.7
Base URL
https://api.zamzar.com/v1/
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zamzar Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Jobs 5

Start a new conversion job plus related operations

GET
/jobs
Retrieve a list of all jobs
listJobs 3 params → 200
POST
/jobs
Submit a conversion job
submitJob body → 201
GET
/jobs/successful
Retrieve a list of all successful jobs
listSuccessfulJobs 3 params → 200
GET
/jobs/{jobId}
Retrieve a specific job
getJobById 1 param → 200
DELETE
/jobs/{jobId}
Cancel a job
cancelJobById 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Job (15 properties), Import (8 properties), File (6 properties), PagingNumeric (4 properties). Each schema is shown below with its type and property counts.

Job
object
Represents the process of converting a file to another format.
15 properties 1 required
PagingNumeric
object
4 properties
Import
object
Represents the process of copying a file from an external URL, (S)FTP server, or an Amazon S3 bucket.
8 properties 1 required
File
object
Represents a file which has been uploaded, imported or converted.
6 properties 2 required
Export
object
An object representing the process of copying converted files to the location specified in the exporturl (when submitting a job via the /jobs endpoint). The st…
4 properties 1 required
Exports
array
An array of objects representing the process of copying converted files to the location specified in the exporturl (when submitting a job via the /jobs endpoin…
Jobs
object
Contains a paged collection of job objects. Newer jobs appear before older jobs.
2 properties
Failure
object
If a process fails, the response will include a failure object to describe the error. If a process is either incomplete or successful, the failure object will…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zamzar-jobs-api-openapi.yml Raw ↑

Other APIs Zamzar publishes across the network.

Zamzar Account API
Zamzar Files API
Zamzar Formats API
Zamzar Imports API
Zamzar Welcome API