If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
get/orgs/{org}/settings/network-configurations
Copy to clipboard curl request example
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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" } ] }
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.
This endpoint works with the following fine-grained token types:
The fine-grained token must have the following permission set:
accept
string
Setting to application/vnd.github+json
is recommended.
org
string Required
The organization name. The name is not case sensitive.
Body parameters Name, Type, Descriptionname
string 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
string
The hosted compute service to use for the network configuration.
Can be one of: none
, actions
network_settings_ids
array of strings Required
The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.
HTTP response status codes for "Create a hosted compute network configuration for an organization" Status code Description201
Created
Code samples for "Create a hosted compute network configuration for an organization"If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
post/orgs/{org}/settings/network-configurations
Copy to clipboard curl request example
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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" }
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
get/orgs/{org}/settings/network-configurations/{network_configuration_id}
Copy to clipboard curl request example
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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" }
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.
This endpoint works with the following fine-grained token types:
The fine-grained token must have the following permission set:
accept
string
Setting to application/vnd.github+json
is recommended.
org
string Required
The organization name. The name is not case sensitive.
network_configuration_id
string Required
Unique identifier of the hosted compute network configuration.
Body parameters Name, Type, Descriptionname
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.
Can be one of: none
, actions
network_settings_ids
array of strings
The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.
HTTP response status codes for "Update a hosted compute network configuration for an organization" Status code Description200
OK
Code samples for "Update a hosted compute network configuration for an organization"If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
patch/orgs/{org}/settings/network-configurations/{network_configuration_id}
Copy to clipboard curl request example
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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" }
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
get/orgs/{org}/settings/network-settings/{network_settings_id}
Copy to clipboard curl request example
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ 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" }
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4