List resources

Returns a machine-readable list of Clumio REST API resources, endpoints, and their supported versions.

Every request must include an HTTP header with the Accept key to define the version of the API to be used.
The current release's version string is returned in the Content Type HTTP response header. This version string should be used as the Accept header's value to use the newest version of the API. Version strings are provided in the following format:

• `Accept: application/api.clumio.*=v<version>+json` sets the common version to the specified version.
• `Accept: application/api.clumio.*=v2&users=v1&tasks=v1+json` sets the common version to v2 while setting the version of the `tasks` and `users` resources to v1.

If the above header is passed to the discovery request, the response is filtered to return the relevant resources and versions only. The requested_version field for each resource specifies the version requested in the Accept header.

For more information about versioning, refer to the Versioning section of this guide.

For more information about the Discovery API, refer to the Discovery API section of this guide.

Responses

• 200

---

The response for the Discovery API.

application/api.clumio.discovery=v1+json

• Schema
• Example (from schema)

---

Schema

• resource_name object

  A description of the available APIs for the resource.

  major_version object

  A supported major version for the resource. Each supported major version lists the operation IDs supported in that release. A resource may have multiple supported major versions.

  operation_id object

  An operation defined on the resource for this version.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

  requested_version string

  The requested version of the resource as provided in the "Accept" request header. This is an optional field and is returned only when a valid "Accept" header is present in request.

  supported_versions string[]

  A list of supported versions for the resource, sorted in descending order starting with the latest release version.

{
  "resource_name": {
    "major_version": {
      "operation_id": {
        "href": "string",
        "templated": true,
        "type": "string"
      }
    },
    "requested_version": "string",
    "supported_versions": [
      "string"
    ]
  }
}

Loading...