Skip to content
forgit api docs

List hosted compute network configurations for an organization

GET
/orgs/{org}/settings/network-configurations

Lists all hosted compute network configurations configured in an organization.

OAuth app tokens and personal access tokens (classic) need the read: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.

Query Parameters

Section titled “ Query Parameters ”
per_page
integer
default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page
integer
default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
object
total_count
required
integer
network_configurations
required
Array<object>
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 
{
  "total_count": 2,
  "network_configurations": [
    {
      "id": "123456789ABCDEF",
      "name": "My network configuration",
      "compute_service": "actions",
      "network_settings_ids": [
        "23456789ABDCEF1",
        "3456789ABDCEF12"
      ],
      "created_on": "2022-10-09T23:39:01Z"
    },
    {
      "id": "456789ABDCEF123",
      "name": "My other configuration",
      "compute_service": "none",
      "network_settings_ids": [
        "56789ABDCEF1234",
        "6789ABDCEF12345"
      ],
      "created_on": "2023-04-26T15:23:37Z"
    }
  ]
}

Headers

Section titled “ Headers ”
Link
string
Example 
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"