Centros de custo - GitHub Enterprise Cloud Docs

Get all cost centers for an enterprise

Gets a list of all the cost centers for an enterprise.

Tokens de acesso refinados para "Get all cost centers for an enterprise"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Get all cost centers for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Parâmetros de consulta
Nome, Tipo, Descrição
`state` string Set to `active` or `deleted` to only list cost centers in a specific state. Pode ser um dos: `active`, `deleted`

Códigos de status de resposta HTTP para "Get all cost centers for an enterprise"

Código de status	Descrição
`200`	Response when getting cost centers
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Exemplos de código para "Get all cost centers for an enterprise"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/enterprises/{enterprise}/settings/billing/cost-centers

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/enterprises/ENTERPRISE/settings/billing/cost-centers

Response when getting cost centers

Status: 200

{
  "costCenters": [
    {
      "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
      "name": "Cost Center Name",
      "state": "active",
      "azure_subscription": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "resources": [
        {
          "type": "User",
          "name": "Monalisa"
        },
        {
          "type": "Repo",
          "name": "octocat/hello-world"
        }
      ]
    },
    {
      "id": "3ffb9ffe-6903-11ee-8c99-0242ac120003",
      "name": "Another Cost Center",
      "state": "active",
      "resources": [
        {
          "type": "User",
          "name": "Octocat"
        }
      ]
    }
  ]
}

Create a new cost center

Creates a new cost center for an enterprise. The authenticated user must be an enterprise admin.

Tokens de acesso refinados para "Create a new cost center"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Create a new cost center"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.

Parâmetros do corpo
Nome, Tipo, Descrição
`name` string Obrigatório The name of the cost center (max length 255 characters)

Códigos de status de resposta HTTP para "Create a new cost center"

Código de status	Descrição
`200`	Cost center created successfully
`400`	Bad request
`409`	Conflict
`500`	Internal server error

Exemplos de código para "Create a new cost center"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

post/enterprises/{enterprise}/settings/billing/cost-centers

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/enterprises/ENTERPRISE/settings/billing/cost-centers \
  -d '{"name":"Engineering Team"}'

Example response for a created cost center

Status: 200

{
  "id": "abc123",
  "name": "Engineering Team",
  "resources": []
}

Get a cost center by ID

Gets a cost center by ID. The authenticated user must be an enterprise admin.

Tokens de acesso refinados para "Get a cost center by ID"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Get a cost center by ID"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.
`cost_center_id` string Obrigatório The ID corresponding to the cost center.

Códigos de status de resposta HTTP para "Get a cost center by ID"

Código de status	Descrição
`200`	Response when getting a cost center
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Exemplos de código para "Get a cost center by ID"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_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/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID

Response when getting a cost center

Status: 200

{
  "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
  "name": "Cost Center Name",
  "state": "active",
  "azure_subscription": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "resources": [
    {
      "type": "User",
      "name": "Monalisa"
    },
    {
      "type": "Repo",
      "name": "octocat/hello-world"
    }
  ]
}

Update a cost center name

Updates an existing cost center name.

Tokens de acesso refinados para "Update a cost center name"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Update a cost center name"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name
`cost_center_id` string Obrigatório The unique identifier of the cost center

Parâmetros do corpo
Nome, Tipo, Descrição
`name` string Obrigatório The new name for the cost center

Códigos de status de resposta HTTP para "Update a cost center name"

Código de status	Descrição
`200`	Response when updating a cost center
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`500`	Internal Error
`503`	Service unavailable

Exemplos de código para "Update a cost center name"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

patch/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_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/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID \
  -d '{"name":"New Cost Center Name"}'

Response when updating a cost center

Status: 200

{
  "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
  "name": "Cost Center Name",
  "state": "active",
  "azure_subscription": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "resources": [
    {
      "type": "User",
      "name": "Monalisa"
    },
    {
      "type": "Repo",
      "name": "octocat/hello-world"
    }
  ]
}

Delete a cost center

Archieves a cost center by ID. The authenticated user must be an enterprise admin.

Tokens de acesso refinados para "Delete a cost center"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Delete a cost center"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.
`cost_center_id` string Obrigatório The ID corresponding to the cost center.

Códigos de status de resposta HTTP para "Delete a cost center"

Código de status	Descrição
`200`	Response when deleting a cost center
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error
`503`	Service unavailable

Exemplos de código para "Delete a cost center"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

delete/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_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/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID

Response when deleting a cost center

Status: 200

{
  "message": "Cost center successfully deleted.",
  "id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
  "name": "cc3",
  "costCenterState": "CostCenterArchived"
}

Add resources to a cost center

Adds resources to a cost center.

The usage for the resources will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.

Tokens de acesso refinados para "Add resources to a cost center"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Add resources to a cost center"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.
`cost_center_id` string Obrigatório The ID corresponding to the cost center.

Parâmetros do corpo
Nome, Tipo, Descrição
`users` array of strings The usernames of the users to add to the cost center.
`organizations` array of strings The organizations to add to the cost center.
`repositories` array of strings The repositories to add to the cost center.

Códigos de status de resposta HTTP para "Add resources to a cost center"

Código de status	Descrição
`200`	Response when adding resources to a cost center
`400`	Bad Request
`403`	Forbidden
`409`	Conflict
`500`	Internal Error
`503`	Service unavailable

Exemplos de código para "Add resources to a cost center"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

post/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource

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/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID/resource \
  -d '{"users":["monalisa"]}'

Response when adding resources to a cost center

Status: 200

{
  "message": "Resources successfully added to the cost center.",
  "reassigned_resources": [
    {
      "resource_type": "user",
      "name": "monalisa",
      "previous_cost_center": "old-cost-center"
    },
    {
      "resource_type": "organization",
      "name": "octo-org",
      "previous_cost_center": "another-cost-center"
    },
    {
      "resource_type": "repository",
      "name": "octo-repo",
      "previous_cost_center": "yet-another-cost-center"
    }
  ]
}

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name.
`cost_center_id` string Obrigatório The ID corresponding to the cost center.

Parâmetros do corpo
Nome, Tipo, Descrição
`users` array of strings The usernames of the users to remove from the cost center.
`organizations` array of strings The organizations to remove from the cost center.
`repositories` array of strings The repositories to remove from the cost center.

Códigos de status de resposta HTTP para "Remove resources from a cost center"

Código de status	Descrição
`200`	Response when removing resources from a cost center
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Exemplos de código para "Remove resources from a cost center"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

delete/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource

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/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID/resource \
  -d '{"users":["monalisa"]}'

Response when removing resources from a cost center

Status: 200

{
  "message": "Resources successfully removed from the cost center."
}