Globus Connect Server Manager API

The Globus Connect Server Manager API provides interfaces for configuring a GCS endpoint and managing storage gateways, user credentials, and collections.

The GCS API follows the REST design model, with resources representing storage gateways and their policies, user credentials, and collections.

All operations return a variation of the Result data type, defines the base message and response code, extended with operation-specific response data.

Changes

1.32.0

  • GCS 5.4.80 release

  • Added support for consistency checks for collections

    • New routes: GET /collections/<uuid>/check, GET /collections/check

    • New data types: check_result#1.0.0

1.31.0

  • GCS 5.4.79 release

  • collection#1.12.0 adds restrict_transfers_to_high_assurance.

1.30.0

  • GCS 5.4.78 release

  • Added support for multiple S3 keys based on a pattern match to a bucket/object path prefix.

1.29.0

  • GCS 5.4.76 release

  • Added support for overriding the endpoint’s network use parameters to storage_gateway#1.3.0.

  • collection#1.11.0 adds acl_expiration_mins for high assurance guest collections

1.28.0

  • GCS 5.4.74 release

  • collection#1.10.0 adds acl_expiration_mins for high assurance mapped collections

1.27.0

  • GCS 5.4.73 release

  • result#1.1.0 adds optional authorization_parameters to result.

1.26.0

  • GCS 5.4.72 release

  • connector#1.1.0 adds is_ha and is_baa fields for high assurance subscriptions

1.25.0

  • GCS 5.4.71 release

  • Mapped collection owner can be changed on managed endpoints by using the new /collections/<uuid:collection_id>/owner API endpoint.

1.24.0

  • GCS 5.4.70 release

  • Add Dropbox connector

1.23.0

  • GCS 5.4.69 release

  • Mapped collections are delete protected on creation unless the document explicitly disables it. Existing collections are not changed.

1.22.0

  • GCS 5.4.67 release

  • Collection listing can now filter by storage gateway ID.

1.21.0

  • GCS 5.4.67 release

  • Mapped collection admins can view the roles of attached guest collections.

  • Collection schema collection#1.1.0 now accepts ~ in collection_base_path.

  • Sharing restrict paths and sharing policies allow $HOME and ~ when root_path is /.

1.20.0

  • GCS 5.4.66 release

  • Add read-only earliest_last_access property to the endpoint. This is the date when this endpoint started tracking last_access on collections. Clients can use this value to determine bounds on whether this collection was never accessed or not accessed since the endpoint started tracking that information.

  • Add login_name policy to the HPSS storage gateway.

1.19.0

  • GCS 5.4.65 release

  • Add allow_any_account to the storage gateway connector policies of connectors that use oauth2 user credentials: Azure Blob, Box, Google Cloud Storage, Google Drive, and OneDrive.

  • Google Cloud Storage collections are no longer required to be associated with a project.

1.18.0

  • GCS 5.4.60 release

  • Add the read-only created_at and last_access properties to the collection schema.

  • Add new filter query parameter value to GET /api/collections to allow filtering collections by created_at or last_access property values.

  • Add new API for deleting multiple guest collections in one request.

1.17.0

  • GCS 5.4.59 release

  • Add s3_requester_pays support to the S3 connector.

1.16.0

  • GCS 5.4.58 release

  • Allow users with an administrator role on a mapped collection to delete guest collections associated with that collection.

  • GET /storage_gateways no longer quietly ignores private_policies

1.15.0

  • GCS 5.4.57 release

  • Add guest_auth_policy_id for collections

  • Increase maxLength of user_message to 256

  • Clarify visibility of root_path on guest collections

  • Add delete_protected for collections

1.14.0

  • GCS 5.4.55 release

  • Add endpoint#1.1.0 document type to support setting GridFTP control port to something other than 443

1.13.0

  • GCS 5.4.51 release

  • Add include=all optional query parameter to GET /user_credentials.

1.12.0

  • GCS 5.4.49 release

  • Add admin_managed_credentials property to storage_gateway#1.2.0

1.11.0

  • GCS 5.4.43 release

  • Add API routes for endpoint and collection advertised owner_string.

  • Add HPSS connector

1.10.0

  • GCS 5.4.30 release

  • Add service_account_key to google_cloud_storage_policies#1.0.0

1.9.0

  • GCS 5.4.28 release

  • Add Azure Blob storage support

1.8.0

  • GCS 5.4.27 release

  • Added disable_anonymous_writes to collection#1.5.0

1.7.0

  • GCS 5.4.21 release

  • Added support for the multi-factor requirement to storage gateways

  • Added force_verify to collection#1.4.0

  • Add ActiveScale connector

1.6.0

  • GCS 5.4.18 release

  • Add OneDrive connector and related policy documents

  • Replace google-cloud-platform-connector module with a more correct oauth-credential-api module.

  • Add support for user sharing policies

1.5.0

  • GCS 5.4.15 release

  • Add node#1.1.0 document

1.4.0

  • GCS 5.4.13 release

  • Add custom domain APIs: the /endpoint/domain and /collections/{collection_id}/domain route and the custom_domain#1.0.0 document.

1.3.0

  • GCS 5.4.10 release

  • Add POSIX staging connector and related policy documents.

  • Add iRODS connector and related policy documents

1.2.0

  • GCS 5.4.8 release

  • Add sharing_users_allow, sharing_users_deny to the Collection document (collection#1.2.0)

  • Add sharing_groups_allow, sharing_groups_deny to the Posix Collection Policies document (posix_collection_policies#1.1.0)

1.1.0

  • GCS 5.4.5 release

  • Add enable_https, user_message, and user_message_link to Collection document (collection#1.1.0)

1.0.0

  • GCS 5.4.0 release

API Reference