Skip to main content
GET
Describe custom network
Returns a custom network, including the cloud provider network instances created inside it.

Authorization

Session cookie set by Sign in: omnistrate_token=<jwt>.

Path parameters

string
required
ID of the custom network.

Response

string
required
ID of the custom network.
string
Friendly name of the network.
string
required
CIDR block reserved for the network.
string
required
Cloud provider the network belongs to.
string
required
Region the network is created in.
string
Status of the network.
string
Type of the network definition.
object
Network feature flags.
object[]
Cloud provider networks created within this custom network.
string
ID of the user that owns the network.
string
Name of the user that owns the network.
string
Time the network was created.
string
Time the network was last updated.

Errors

See Error for the error response shape.