Globus Connect Server Administration Guides
  • Quickstart Guide
  • Installation Guide
  • Data Access Admin Guide
  • Domain Guide
  • HTTPS Access to Collections
  • Identity Mapping Admin Guide
  • Globus OIDC Installation Guide
  • v5.3 Migration Guide
  • Troubleshooting Guide
  • Command-Line Reference
    • Audit
      • Load
      • Query
      • Dump
    • Endpoint
      • Setup
      • Show
      • Update
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription ID
      • Migrate53
      • Cleanup
      • Domain
      • Role
      • Upgrade
    • OIDC
      • Create
      • Delete
      • Register
      • Show
      • Update
    • Node
      • Create
      • Setup
      • List
      • Show
      • Update
      • Cleanup
      • Update Vhost
      • Delete
    • Login
    • Session
      • Consent
      • Show
      • Update
    • Whoami
    • Logout
    • Storage Gateway
      • Create
      • List
      • Show
      • Update
      • Delete
    • Collection
      • Create
      • List
      • Show
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Update
      • Delete
      • Domain
      • Role
    • Sharing Policy
      • Create
      • List
      • Show
      • Delete
    • Self Diagnostic
  • Globus Connect Server Manager API
    • Responses
    • Schemas
    • Authorization
    • Versioning
    • Endpoint
    • Roles
    • Nodes
    • Storage Gateways
    • Collections
    • User Credentials
    • Domains
    • Sharing Policies
    • ActiveScale
    • Azure Blob
      • Azure Blob
    • BlackPearl
    • Box
    • Ceph
    • Google Cloud Storage
    • Google Drive
    • HPSS
    • iRODS Connector
    • OAuth Credential API
    • OneDrive
    • POSIX Connector
    • POSIX Staging Connector
    • S3
  • API Access for Portals
  • Application Migration Guide
  • Change Log
Skip to main content
Globus Docs
  • APIs
    Auth Transfer Groups Search Python SDK Helper Pages
  • How To
  • Guides
    Globus Connect Server High Assurance Collections for Protected Data Command Line Interface Premium Storage Connectors Globus Automation Services Security Modern Research Data Portal
  • Support
    FAQs Mailing Lists Contact Us Check Support Tickets
  1. Home
  2. Globus Connect Server
  3. Installation Guide
  4. Globus Connect Server Manager API

Nodes

Nodes

Services for GCS endpoints may be deployed on multiple different physical resources. The Nodes API allows an administrator to manage those nodes.

Overview

Method API Path Description

GET

/​nodes

Get Nodes

POST

/​nodes

Create Node

Overview

Method API Path Description

GET

/​nodes/​{node_id}

Get Node

DELETE

/​nodes/​{node_id}

Delete Node

PATCH

/​nodes/​{node_id}

Update Node (PATCH)

PUT

/​nodes/​{node_id}

Update Node (PUT)

Common Path Parameters

Parameter Type Description

node_id (required)

string Any

ID of the node.

Details

Get Nodes

GET /nodes

Get the Globus Connect Server’s list of Node documents.

This operation requires either the endpoint to have the public property set to true or the caller to have a role that allows viewing this Endpoint or a Collection on it.

Authorization

  • PublicAuthorizer

  • RoleAuthorizer: [ endpoint:owner, endpoint:administrator, endpoint:activity_manager, endpoint:activity_monitor, collection:administrator:*, collection:activity_manager:*, collection:activity_monitor:*, collection:access_manager:* ]

  • CollectionACLAuthorizer: [ * ]

  • StorageGatewayAuthorizer [ * ]

Query Parameters

Parameter Type Description

marker

string Any

Pagination marker for a paginated response

Responses

200 - Get Nodes Result
Table 1. application/json

Name

Type

Description

code

string success

data

array ( Node )

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.

{
  "code": "success",
  "data": [
    {
      "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
      "ip_addresses": [
        "192.168.44.2"
      ],
      "status": "active",
      "incoming_port_range": [
        50000,
        51000
      ],
      "outgoing_port_range": [
        50000,
        51000
      ],
      "DATA_TYPE": "node#1.0.0"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "http_response_code": 200,
  "detail": null,
  "message": "Operation successful",
  "has_next_page": false,
  "marker": "string"
}
400 - Bad request
401 - Unauthorized
403 - Permission Denied

Create Node

POST /nodes

Create a new Node document to describe a server which is providing service for this GCS Endpoint. This adds the node’s IP address to the DNS record for this Endpoint’s GCS Manager and for all collections.

On success returns a copy of the created Node with the system generated id added.

Authorization

  • RoleAuthorizer: [ endpoint:owner, endpoint:administrator ]

Request body

application/json

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as Data Transfer Nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Name

Type

Description

body

Node One of { Node 1.0.0 , Node 1.1.0 ​ }

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as Data Transfer Nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Example
{
  "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
  "ip_addresses": [
    "192.168.44.2"
  ],
  "status": "active",
  "incoming_port_range": [
    50000,
    51000
  ],
  "outgoing_port_range": [
    50000,
    51000
  ],
  "DATA_TYPE": "node#1.0.0"
}

Responses

200 - Create Node response
Table 2. application/json

Name

Type

Description

code

string success

data

array ( Node )

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.

{
  "code": "success",
  "data": [
    {
      "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
      "ip_addresses": [
        "192.168.44.2"
      ],
      "status": "active",
      "incoming_port_range": [
        50000,
        51000
      ],
      "outgoing_port_range": [
        50000,
        51000
      ],
      "DATA_TYPE": "node#1.0.0"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "http_response_code": 200,
  "detail": null,
  "message": "Operation successful",
  "has_next_page": false,
  "marker": "string"
}
400 - Bad request
401 - Unauthorized
403 - Missing required role
409 - Resource Exists
415 - UnsupportedMedia
422 - UnprocessableEntity

Details

Get Node

GET /nodes/{node_id}

Get the one of the Globus Connect Server’s Node documents.

Get the Globus Connect Server’s list of Node documents.

This operation requires either the endpoint to have the public property set to true or the caller to have a role that allows viewing this Endpoint or a Collection on it.

Authorization

  • PublicAuthorizer

  • RoleAuthorizer: [ endpoint:owner, endpoint:administrator, endpoint:activity_manager, endpoint:activity_monitor, collection:administrator:*, collection:activity_manager:*, collection:activity_monitor:*, collection:access_manager:* ]

  • CollectionACLAuthorizer: [ * ]

  • StorageGatewayAuthorizer [ * ]

Responses

200 - Get Nodes Result
Table 3. application/json

Name

Type

Description

code

string success

data

array ( Node )

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.

{
  "code": "success",
  "data": [
    {
      "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
      "ip_addresses": [
        "192.168.44.2"
      ],
      "status": "active",
      "incoming_port_range": [
        50000,
        51000
      ],
      "outgoing_port_range": [
        50000,
        51000
      ],
      "DATA_TYPE": "node#1.0.0"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "http_response_code": 200,
  "detail": null,
  "message": "Operation successful",
  "has_next_page": false,
  "marker": "string"
}
401 - Unauthorized
403 - Permission Denied
404 - Not Found

Delete Node

DELETE /nodes/{node_id}

Delete a Node document on this Endpoint. This removes the node’s IP address from the DNS record for this GCS Endpoint so that clients will no longer contact that node for service for that Endpoint.

Authorization

  • RoleAuthorizer: [ endpoint:owner, endpoint:administrator ]

Responses

200 - Delete node result
Table 4. application/json

Name

Type

Description

code

string success

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.

data

array (object)

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.

{
  "code": "success",
  "DATA_TYPE": "result#1.0.0",
  "http_response_code": 200,
  "detail": null,
  "message": "Operation successful",
  "data": [
    {}
  ],
  "has_next_page": false,
  "marker": "string"
}
401 - Unauthorized
403 - Missing required role
404 - Not Found

Update Node (PATCH)

PATCH /nodes/{node_id}

Update the Node document, changing only the properties included in the input document. Items explicitly set to null in the input are removed from the Node document. This operation optionally returns the Node after applying the changes in the input if the include=node query parameter is passed to this operation.

Authorization

  • RoleAuthorizer: [ endpoint:owner, endpoint:administrator ]

Query Parameters

Parameter Type Description

include

array(string) node

List of document types to include in the response.

Request body

application/json

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as Data Transfer Nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Name

Type

Description

body

Node One of { Node 1.0.0 , Node 1.1.0 ​ }

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as Data Transfer Nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Example
{
  "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
  "ip_addresses": [
    "192.168.44.2"
  ],
  "status": "active",
  "incoming_port_range": [
    50000,
    51000
  ],
  "outgoing_port_range": [
    50000,
    51000
  ],
  "DATA_TYPE": "node#1.0.0"
}

Responses

200 - Update node result
Table 5. application/json

Name

Type

Description

code

string success

data

array ( Node )

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.

{
  "code": "success",
  "data": [
    {
      "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
      "ip_addresses": [
        "192.168.44.2"
      ],
      "status": "active",
      "incoming_port_range": [
        50000,
        51000
      ],
      "outgoing_port_range": [
        50000,
        51000
      ],
      "DATA_TYPE": "node#1.0.0"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "http_response_code": 200,
  "detail": null,
  "message": "Operation successful",
  "has_next_page": false,
  "marker": "string"
}
401 - Unauthorized
403 - Permission Denied
404 - Not Found
409 - Resource Exists
415 - UnsupportedMedia
422 - UnprocessableEntity

Update Node (PUT)

PUT /nodes/{node_id}

Update the Node document, replacing all properties with those in the input. This operation optionally returns the Node after the update if the include=node query parameter is passed to this operation.

Authorization

  • RoleAuthorizer: [ endpoint:owner, endpoint:administrator ]

Query Parameters

Parameter Type Description

include

array(string) node

List of document types to include in the response.

Request body

application/json

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as Data Transfer Nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Name

Type

Description

body

Node One of { Node 1.0.0 , Node 1.1.0 ​ }

Services for Globus Connect Server endpoints may be deployed on multiple different physical resources, referred to as Data Transfer Nodes. Each node may have one or more IP addresses, TCP incoming and outgoing port ranges, and a status value indicating whether it is configured to actively respond to requests or is in maintenance mode.

Example
{
  "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
  "ip_addresses": [
    "192.168.44.2"
  ],
  "status": "active",
  "incoming_port_range": [
    50000,
    51000
  ],
  "outgoing_port_range": [
    50000,
    51000
  ],
  "DATA_TYPE": "node#1.0.0"
}

Responses

200 - Update node result
Table 6. application/json

Name

Type

Description

code

string success

data

array ( Node )

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.

{
  "code": "success",
  "data": [
    {
      "id": "5a91ee5a-b28f-44b8-b0cb-2adbd5beee2c",
      "ip_addresses": [
        "192.168.44.2"
      ],
      "status": "active",
      "incoming_port_range": [
        50000,
        51000
      ],
      "outgoing_port_range": [
        50000,
        51000
      ],
      "DATA_TYPE": "node#1.0.0"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "http_response_code": 200,
  "detail": null,
  "message": "Operation successful",
  "has_next_page": false,
  "marker": "string"
}
401 - Unauthorized
403 - Permission Denied
404 - Not Found
409 - Resource Exists
415 - UnsupportedMedia
422 - UnprocessableEntity
  • Quickstart Guide
  • Installation Guide
  • Data Access Admin Guide
  • Domain Guide
  • HTTPS Access to Collections
  • Identity Mapping Admin Guide
  • Globus OIDC Installation Guide
  • v5.3 Migration Guide
  • Troubleshooting Guide
  • Command-Line Reference
    • Audit
      • Load
      • Query
      • Dump
    • Endpoint
      • Setup
      • Show
      • Update
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Set Owner
      • Set Subscription ID
      • Migrate53
      • Cleanup
      • Domain
      • Role
      • Upgrade
    • OIDC
      • Create
      • Delete
      • Register
      • Show
      • Update
    • Node
      • Create
      • Setup
      • List
      • Show
      • Update
      • Cleanup
      • Update Vhost
      • Delete
    • Login
    • Session
      • Consent
      • Show
      • Update
    • Whoami
    • Logout
    • Storage Gateway
      • Create
      • List
      • Show
      • Update
      • Delete
    • Collection
      • Create
      • List
      • Show
      • Reset Advertised Owner String
      • Set Advertised Owner String
      • Update
      • Delete
      • Domain
      • Role
    • Sharing Policy
      • Create
      • List
      • Show
      • Delete
    • Self Diagnostic
  • Globus Connect Server Manager API
    • Responses
    • Schemas
    • Authorization
    • Versioning
    • Endpoint
    • Roles
    • Nodes
    • Storage Gateways
    • Collections
    • User Credentials
    • Domains
    • Sharing Policies
    • ActiveScale
    • Azure Blob
      • Azure Blob
    • BlackPearl
    • Box
    • Ceph
    • Google Cloud Storage
    • Google Drive
    • HPSS
    • iRODS Connector
    • OAuth Credential API
    • OneDrive
    • POSIX Connector
    • POSIX Staging Connector
    • S3
  • API Access for Portals
  • Application Migration Guide
  • Change Log
© 2010- The University of Chicago Legal Privacy Accessibility