Get a hosted compute network configuration for an organization

2 parameters

orgstringrequired

The organization name. The name is not case sensitive.

network_configuration_idstringrequired

Unique identifier of the hosted compute network configuration.

1 status code

200Response

idstringrequired

The unique identifier of the network configuration.

namestringrequired

The name of the network configuration.

compute_servicestringoptional

The hosted compute service the network configuration supports.

Allowed:noneactionscodespaces

network_settings_idsarray<string>optional

The unique identifier of each network settings in the configuration.

failover_network_settings_idsarray<string>optional

The unique identifier of each failover network settings in the configuration.

failover_network_enabledbooleanoptional

Indicates whether the failover network resource is enabled.

created_onstringrequired

The time at which the network configuration was created, in ISO 8601 format.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.networkConfigurations.get({
  org: "acme-inc",
  networkConfigurationId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "id": "123456789ABCDEF",
  "name": "My network configuration",
  "compute_service": "actions",
  "network_settings_ids": [
    "23456789ABDCEF1",
    "3456789ABDCEF12"
  ],
  "created_on": "2022-10-09T23:39:01Z"
}

Request

Response