REST API endpoints for network configurations

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.

Подробные маркеры доступа для "List hosted compute network configurations for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Network configurations" organization permissions (read)

Параметры для "List hosted compute network configurations for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
`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-ответа для "List hosted compute network configurations for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "List hosted compute network configurations for an organization"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

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

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

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.

Подробные маркеры доступа для "Create a hosted compute network configuration for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Network configurations" organization permissions (write)

Параметры для "Create a hosted compute network configuration for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
`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 Обязательное поле The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

Коды состояния http-ответа для "Create a hosted compute network configuration for an organization"

Код состояния	Описание
`201`	Created

Примеры кода для "Create a hosted compute network configuration for an organization"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

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: 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"
}

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.

Подробные маркеры доступа для "Get a hosted compute network configuration for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Network configurations" organization permissions (read)

Параметры для "Get a hosted compute network configuration for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`network_configuration_id` string Обязательное поле Unique identifier of the hosted compute network configuration.

Коды состояния http-ответа для "Get a hosted compute network configuration for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "Get a hosted compute network configuration for an organization"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

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: 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"
}

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.

Подробные маркеры доступа для "Update a hosted compute network configuration for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Network configurations" organization permissions (write)

Параметры для "Update a hosted compute network configuration for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`network_configuration_id` string Обязательное поле Unique identifier of the hosted compute network configuration.

Параметры запроса
Имя., Тип, Description
`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 The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified.

Коды состояния http-ответа для "Update a hosted compute network configuration for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "Update a hosted compute network configuration for an organization"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

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: 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"
}

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.

Подробные маркеры доступа для "Delete a hosted compute network configuration from an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Network configurations" organization permissions (write)

Параметры для "Delete a hosted compute network configuration from an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`network_configuration_id` string Обязательное поле Unique identifier of the hosted compute network configuration.

Коды состояния http-ответа для "Delete a hosted compute network configuration from an organization"

Код состояния	Описание
`204`	No Content

Примеры кода для "Delete a hosted compute network configuration from an organization"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

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: 2022-11-28" \
  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.

Подробные маркеры доступа для "Get a hosted compute network settings resource for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Network configurations" organization permissions (read)

Параметры для "Get a hosted compute network settings resource for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`network_settings_id` string Обязательное поле Unique identifier of the hosted compute network settings.

Коды состояния http-ответа для "Get a hosted compute network settings resource for an organization"

Код состояния	Описание
`200`	OK

Примеры кода для "Get a hosted compute network settings resource for an organization"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

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: 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"
}