ネットワーク構成用の REST API エンドポイント

List hosted compute network configurations for an organization

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.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Network configurations" organization permissions (read)

"List hosted compute network configurations for an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`org` string 必須 The organization name. The name is not case sensitive.

クエリパラメーター
名前, タイプ, 説明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." デフォルト: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." デフォルト: `1`

http_status_code

status_code	説明
`200`	OK

code_samples

request_example

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/settings/network-configurations

Response

Status: 200

{
  "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"
    }
  ]
}

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.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Network configurations" organization permissions (write)

"Create a hosted compute network configuration for an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`org` string 必須 The organization name. The name is not case sensitive.

ボディパラメータ
名前, タイプ, 説明
`name` string 必須 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` string The hosted compute service to use for the network configuration. 次のいずれかにできます: `none`, `actions`
`network_settings_ids` array of strings 必須 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_ids` array of strings 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_enabled` boolean Indicates whether the failover network resource is enabled.

http_status_code

status_code	説明
`201`	Created

code_samples

request_example

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

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/settings/network-configurations \
  -d '{"name":"my-network-configuration","network_settings_ids":["23456789ABDCEF1"],"compute_service":"actions"}'

Response

Status: 201

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

Get a hosted compute network configuration for an organization

Gets a hosted compute network configuration configured in an organization.

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

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Network configurations" organization permissions (read)

"Get a hosted compute network configuration for an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`org` string 必須 The organization name. The name is not case sensitive.
`network_configuration_id` string 必須 Unique identifier of the hosted compute network configuration.

http_status_code

status_code	説明
`200`	OK

code_samples

request_example

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/settings/network-configurations/NETWORK_CONFIGURATION_ID

Response

Status: 200

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

Update a hosted compute network configuration for an organization

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.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Network configurations" organization permissions (write)

"Update a hosted compute network configuration for an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`org` string 必須 The organization name. The name is not case sensitive.
`network_configuration_id` string 必須 Unique identifier of the hosted compute network configuration.

ボディパラメータ
名前, タイプ, 説明
`name` string 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` string The hosted compute service to use for the network configuration. 次のいずれかにできます: `none`, `actions`
`network_settings_ids` array of strings 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_ids` array of strings 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_enabled` boolean Indicates whether the failover network resource is enabled.

http_status_code

status_code	説明
`200`	OK

code_samples

request_example

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

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/settings/network-configurations/NETWORK_CONFIGURATION_ID \
  -d '{"name":"my-network-configuration","network_settings_ids":["23456789ABDCEF1"],"compute_service":"actions"}'

Response

Status: 200

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

Delete a hosted compute network configuration from an organization

Deletes a hosted compute network configuration from an organization.

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

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Network configurations" organization permissions (write)

"Delete a hosted compute network configuration from an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`org` string 必須 The organization name. The name is not case sensitive.
`network_configuration_id` string 必須 Unique identifier of the hosted compute network configuration.

http_status_code

status_code	説明
`204`	No Content

code_samples

request_example

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/settings/network-configurations/NETWORK_CONFIGURATION_ID

Response

Status: 204

Get a hosted compute network settings resource for an organization

Gets a hosted compute network settings resource configured for an organization.

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

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Network configurations" organization permissions (read)

"Get a hosted compute network settings resource for an organization" のパラメーター

ヘッダー
名前, タイプ, 説明
`accept` string Setting to `application/vnd.github+json` is recommended.

パスパラメーター
名前, タイプ, 説明
`org` string 必須 The organization name. The name is not case sensitive.
`network_settings_id` string 必須 Unique identifier of the hosted compute network settings.

http_status_code

status_code	説明
`200`	OK

code_samples

request_example

get/orgs/{org}/settings/network-settings/{network_settings_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/settings/network-settings/NETWORK_SETTINGS_ID

Response

Status: 200

{
  "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D",
  "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562",
  "name": "my_network_settings",
  "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet",
  "region": "eastus"
}