Fetch Single Hub

Use this API call to fetch a hub.

query
  • meta

    Accepted Values: membership

  • sort

    Sorts can be performed on any field - see sorting

  • filter

    Collections of resources can be filtered based on certain criteria - see filtering 

Returns

Returns an hub resource, otherwise returns an Error.

GET /v1/hub/current

Example Request
$ curl https://api.cycle.io/v1/hubs/current \
  -H 
"Authorization: Bearer  API_KEY"
 \
  -H 
"X-HUB-ID:  HUB_ID"
Example Response
{
  "data": {
    "id": "5cc78aa0db2ab000014a8b98",
    "name": "MyHub",
    "creator": {
      "type": "account",
      "id": "5cc78aa0db2ab000014a8b98"
    },
    "events": {
      "created": "2019-11-22T02:15:52.091Z",
      "updated": "0001-01-01T00:00:00Z",
      "deleted": "0001-01-01T00:00:00Z"
    },
    "state": {
      "changed": "2019-11-22T02:16:50.848Z",
      "current": "live"
    },
    "integrations": {
      "letsencrypt": null
    },
    "providers": {
      "equinix_metal": {
        "api_key": "3GR*****************************",
        "project": "cdwqa510-7547-2s45-u8ui-q13wk9jh4u52"
      },
      "vultr": {
        "api_key": "FHG*********************************"
      },
      "aws": {
        "api_key": "IOP*****************",
        "secret": "uYG*************************************"
      }
    },
    "webhooks": {
      "server_deployed": "https://demo.endpoint.com"
    },
    "billing": {
      "term": {
        "start": "2019-12-22T22:38:57.506Z",
        "end": "2020-01-22T22:38:57.506Z",
        "renew": "monthly"
      },
      "plans": {
        "tier_id": "5cc78aa0db2ab000014a8b98",
        "support_id": "5cc78aa0db2ab000014a8b98"
      }
    },
    "meta": {
      "membership": {
        "id": "5cc78aa0db2ab000014a8b98",
        "account_id": "5cc78aa0db2ab000014a8b98",
        "hub_id": "5cc78aa0db2ab000014a8b98",
        "preferences": {
          "notifications": {
            "api_keys": false
          }
        },
        "events": {
          "created": "2019-04-04T23:22:37.467Z",
          "updated": "2019-04-11T08:11:34.992Z",
          "deleted": "0001-01-01T00:00:00Z",
          "joined": "2019-04-04T23:23:31.73Z"
        },
        "state": {
          "changed": "2019-04-04T23:23:31.731Z",
          "current": "accepted"
        },
        "role": 2,
        "permissions": {
          "all_environments": false,
          "environments": [
            {
              "id": "5b9c2a77b6393d0001eb45fd",
              "manage": false
            }
          ]
        },
        "invitation": {
          "sender": {
            "id": "5cc78aa0db2ab000014a8b98",
            "type": "account"
          },
          "recipient": "youremail@organization.net",
          "events": {
            "accepted": "2019-04-04T23:23:31.73Z",
            "declined": "0001-01-01T00:00:00Z",
            "revoked": "0001-01-01T00:00:00Z"
          }
        }
      }
    }
  }
}