Versioning

API Versioning

The GCS Manager API uses semantic versioning for its API versioning. The version of the API described in this document is 1.0.0.

Connectors

Each Connector providing access to a type of storage will have its own semantic version. This version describes the API specific to that connector, including its input and output document formats and any additional URL routes that it provides.

API Document Versions

Each document in the Globus Connect Server Manager API includes a DATA_TYPE property that indicates the type and version of the document. When a document with a given DATA_TYPE is used in a document, the document must validate against the schema defined for that document type. Note that extensions may be allowed based on the definition of that type.

Deprecations

When a part of the API is to be deprecated, the minor version of the API is increased. When a part of the API is removed, the major version of the API is incremented.

When a deprecated API is used, the response message will include a deprecation warning.

Overview

Method	API Path	Description
`GET`	/info	Get GCS Information

Details

Get GCS Information

GET /info

Returns information about the GCS Manager service for this endpoint, as well as additional features such as connectors that it provides as extensions to the API defined in this document.

This operation can be performed without an Authorization header.

Query Parameters

Parameter	Type	Description
marker	string Any	Pagination marker for a paginated response
page_size	integer Any	Maximum page size for a paginated response

Responses

200 - Get Info Response

Table 1. application/json
Name	Type	Description
code	string `success`
data	array	Array of Info, Connector and other extension information.
DATA_TYPE	string `result#1.0.0`	Type of this document.
http_response_code	integer	Numeric HTTP response code
detail		Machine readable response details
message	string	Message describing this result.
has_next_page	boolean	Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation.
marker	string	Opaque marker that may be passed to this API call to fetch the next page of results if the returned document has `has_next_page` set to true.

{
  "DATA_TYPE": "result#1.0.0",
  "http_response_code": 200,
  "code": "success",
  "message": "Globus Connect Server 5.4.0",
  "data": [
    {
      "DATA_TYPE": "info#1.0.0",
      "manager_version": "5.4.0",
      "api_version": "1.0.0"
    },
    {
      "DATA_TYPE": "connector#1.0.0",
      "display_name": "POSIX",
      "id": "145812c8-decc-41f1-83cf-bb2a85a2a70b",
      "version": "1.0.0"
    }
  ]
}