Sample - GitHub REST API
POST/orgs/{org}/settings/network-configurations

Create a hosted compute network configuration for an organization

Creates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the write:network_configurations scope to use this endpoint.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 5 body fields
orgstringrequired
The organization name. The name is not case sensitive.
namestringrequired
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_servicestringoptional
The hosted compute service to use for the network configuration.
Allowed:noneactions
network_settings_idsarray<string>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_idsarray<string>optional
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_enabledbooleanoptional
Indicates whether the failover network resource is enabled.

1 status code
201Response
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.