The Network Resource

Networks are a way to link together environments with their own private network.

For more information on networks, see the main docs.

Attributes
  • id
    string

    The ID of the Network.

  • name
    string

    The name of the Network.

  • identifier
    string

    The network identifier, used to signify use of the network connecting environments.

  • cluster
    string

    Connected environments must belong to the same cluster. This is the cluster name for this network.

  • owner
    object

    Information about the owner of the network.

    Show child fields
  • hub_id
    string

    This is the ID of the hub the network belongs to.

  • state
    object

    Information regarding the current state of the network.

    Show child fields
  • private_network
    object

    Creating a private network on Cycle creates a new private network between your environments. This produces new network information. That information can be captured here.

    Show child fields
  • environments
    array of objects

    An array of environments connected by this network.

    Show child fields
  • events
    object

    A collection of timestamps for each event in the network's lifetime.

    Show child fields
Example Network
{
"id": "5a98710df231a500017f9aa4",
"name": "Test",
"identifier": "test",
"cluster": "production",
"owner": {
"type": "account",
"id": "3a78910df231a500017f9bb4"
},
"hub_id": "5cc78aa0db2ab000014a8b98",
"state": {
"changed": "2018-09-14T21:39:29.428Z",
"current": "live"
},
"private_network": {
"vxlan_tag": 25564,
"subnet": "a325",
"mac_addr_suffix": 233,
"ipv6": {
"ip": "fdoo:feee:b870::",
"cidr": "fdoo:feee:b870::/64"
}
},
"environments": [
{
"id": "3a78910df231a500017f9bb4",
"added": "2018-10-12T21:43:42.557Z"
}
],
"events": {
"created": "2018-09-14T21:39:03.096Z",
"updated": "2018-09-17T16:50:54.107Z",
"deleted": "0001-01-01T00:00:00Z"
}
}