enterprise-admin
hosted-compute

Create a hosted compute network configuration for an enterprise

Changed on

Creates a hosted compute network configuration for an enterprise.

post/enterprises/{enterprise}/network-configurations

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/network-configurations
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Request body

namestring required

Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, ., -, and _.

compute_service'none' | 'actions'

The hosted compute service to use for the network configuration.

network_settings_idsstring[] required

A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

failover_network_settings_idsstring[]

A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.

failover_network_enabledboolean

Indicates whether the failover network resource is enabled.

Response

Response

idstring required

The unique identifier of the network configuration.

namestring required

The name of the network configuration.

compute_service'none' | 'actions' | 'codespaces'

The hosted compute service the network configuration supports.

network_settings_idsstring[]

The unique identifier of each network settings in the configuration.

failover_network_settings_idsstring[]

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

failover_network_enabledboolean

Indicates whether the failover network resource is enabled.

created_onstring date-time nullable required

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

Example response

{
  "id": "123ABC456DEF789",
  "name": "my-network-configuration",
  "failover_network_enabled": true,
  "created_on": "2024-04-26T11:31:07Z"
}

Changes

  • 2022-11-288cde44a45373Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property