Endpoint_1_0

Endpoint_1_0_0 Document

A Globus Connect Server endpoint is a deployment of Globus Connect Server version 5. A single endpoint may optionally include multiple data transfer nodes. The endpoint provides a link between a Globus Connect Server deployment and the Globus Transfer service. The endpoint describes services for accessing data via GridFTP and HTTPS and also for configuring and managing the policies associated with that access.

Name	Type	Description
DATA_TYPE	string `endpoint#1.0.0`	Type of this document
allow_udt	boolean	Allow data transfer on this endpoint using the UDT protocol
contact_email	string	Email address of the support contact for this endpoint. This is visible to end users so that they may contact your organization for support.
contact_info	string	Other non-email contact information for the endpoint, e.g. phone and mailing address. This is visible to end users for support.
department	string	Department within organization that runs the server(s). Searchable. Unicode string, max 1024 characters, no new lines.
description	string	A description of the endpoint
display_name	string	Friendly name for the endpoint, not unique. Unicode string, no new lines (`\r` or `\n`). Searchable.
id	string <uuid>	Unique identifier for this endpoint
gcs_manager_url	string	URL of the GCS Manager API service for this endpoint
info_link	string	Link to a web page with more information about the endpoint. The administrator is responsible for running a website at this URL and verifying that it is accepting public connections.
keywords	array of string	List of search keywords for the endpoint. Unicode string, max 1024 characters total across all strings.
max_concurrency	integer	Admin-specified value when the network_use property’s value is `custom`; otherwise the preset value for the specified network_use.
max_parallelism	integer	Admin-specified value when the network_use property’s value is `custom`; otherwise the preset value for the specified network_use.
network_use	string `normal`, `minimal`, `aggressive`, `custom`	Control how Globus interacts with this endpoint over the network. Allowed values for network_use are: `normal` The default setting. Uses an average level of concurrency and parallelism. The levels depend on the number of physical servers in the endpoint. `minimal` Uses a minimal level of concurrency and parallelism. `aggressive` Uses a high level of concurrency and parallelism. `custom` Uses custom values of concurrency and parallelism set by the endpoint admin. When setting this level, you must also set the max_concurrency, preferred_concurrency, max_parallelism, and preferred_parallelism properties.
organization	string	Organization that runs the server(s) represented by the endpoint. Unicode string, max 1024 characters, no new lines.
preferred_concurrency	integer	Admin-specified value when the network_use property’s value is `custom`; otherwise the preset value for the specified network_use.
preferred_parallelism	integer	Admin-specified value when the network_use property’s value is `custom`; otherwise the preset value for the specified network_use.
public	boolean	Flag indicating whether this endpoint is visible to all other Globus users. If false, only users which have been granted a role on the endpoint or one of its collections, or belong to a domain allowed access to any of its storage gateways may view it.
subscription_id	string	The id of the subscription that is managing this endpoint. This may be the special value `DEFAULT` when using this as input to PATCH or PUT to use the caller’s default subscription id.

{
  "DATA_TYPE": "endpoint#1.0.0",
  "allow_udt": true,
  "contact_email": "string",
  "contact_info": "string",
  "department": "string",
  "description": "string",
  "display_name": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "gcs_manager_url": "string",
  "info_link": "string",
  "keywords": [
    "string"
  ],
  "max_concurrency": 1,
  "max_parallelism": 1,
  "network_use": "normal",
  "organization": "string",
  "preferred_concurrency": 1,
  "preferred_parallelism": 1,
  "public": true,
  "subscription_id": "string"
}