Skip to content
forgit api docs

Update a hosted compute network configuration for an organization

PATCH
/orgs/{org}/settings/network-configurations/{network_configuration_id}

Updates 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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

network_configuration_id
required
string

Unique identifier of the hosted compute network configuration.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
name

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 ‘_’.

string
compute_service

The hosted compute service to use for the network configuration.

string
Allowed values: none actions
network_settings_ids

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.

Array<string>
0 <= 1 items
failover_network_settings_ids

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.

Array<string>
0 <= 1 items
failover_network_enabled

Indicates whether the failover network resource is enabled.

boolean
Examples
Example default 
{
  "name": "my-network-configuration",
  "network_settings_ids": [
    "23456789ABDCEF1"
  ],
  "compute_service": "actions"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Hosted compute network configuration

A hosted compute network configuration.

object
id
required

The unique identifier of the network configuration.

string
name
required

The name of the network configuration.

string
compute_service

The hosted compute service the network configuration supports.

string
Allowed values: none actions codespaces
network_settings_ids

The unique identifier of each network settings in the configuration.

Array<string>
failover_network_settings_ids

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

Array<string>
failover_network_enabled

Indicates whether the failover network resource is enabled.

boolean
created_on
required

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

string format: date-time
nullable
Examples
Example default 
{
  "id": "123456789ABCDEF",
  "name": "My network configuration",
  "compute_service": "actions",
  "network_settings_ids": [
    "23456789ABDCEF1",
    "3456789ABDCEF12"
  ],
  "created_on": "2022-10-09T23:39:01Z"
}