Pontos de extremidade de API REST para propriedades personalizadas
Use a API REST para criar e gerenciar propriedades personalizadas para uma organização.
Sobre propriedades personalizadas
Você pode usar a API REST para criar e gerenciar propriedades personalizadas para uma organização. Você pode usar propriedades personalizadas para adicionar metadados a repositórios em sua organização. Para obter mais informações, confira "Como gerenciar propriedades personalizadas para repositórios na sua organização".
Get all custom properties for an organization
Gets all custom properties defined for an organization. Organization members can read these properties.
Tokens de acesso refinados para "Get all custom properties for an organization"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Custom properties" organization permissions (read)
Parâmetros para "Get all custom properties for an organization"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Códigos de status de resposta HTTP para "Get all custom properties for an organization"
Código de status | Descrição |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Get all custom properties for an organization"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/properties/schema
Response
Status: 200
[
{
"property_name": "environment",
"url": "https://HOSTNAME/orgs/github/properties/schema/environment",
"value_type": "single_select",
"required": true,
"default_value": "production",
"description": "Prod or dev environment",
"allowed_values": [
"production",
"development"
],
"values_editable_by": "org_actors"
},
{
"property_name": "service",
"url": "https://HOSTNAME/orgs/github/properties/schema/service",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://HOSTNAME/orgs/github/properties/schema/team",
"value_type": "string",
"description": "Team owning the repository"
}
]
Create or update custom properties for an organization
Creates new or updates existing custom properties defined for an organization in a batch.
To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of
custom_properties_org_definitions_manager
in the organization.
Tokens de acesso refinados para "Create or update custom properties for an organization"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Custom properties" organization permissions (admin)
Parâmetros para "Create or update custom properties for an organization"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Tipo, Descrição | |||||||||
---|---|---|---|---|---|---|---|---|---|
properties array of objects ObrigatórioThe array of custom properties to create or update. | |||||||||
Properties of |
Nome, Tipo, Descrição |
---|
property_name string ObrigatórioThe name of the property |
url string The URL that can be used to fetch, update, or delete info about this property via the API. |
value_type string ObrigatórioThe type of the value for the property Pode ser um dos: |
required boolean Whether the property is required. |
default_value null or string or array Default value of the property |
description string or null Short description of the property |
allowed_values array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values. |
values_editable_by string or null Who can edit the values of the property Pode ser um dos: |
Códigos de status de resposta HTTP para "Create or update custom properties for an organization"
Código de status | Descrição |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Create or update custom properties for an organization"
Exemplo de solicitação
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/properties/schema \
-d '{"properties":[{"property_name":"environment","value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"],"values_editable_by":"org_actors"},{"property_name":"service","value_type":"string"},{"property_name":"team","value_type":"string","description":"Team owning the repository"}]}'
Response
Status: 200
[
{
"property_name": "environment",
"url": "https://HOSTNAME/orgs/github/properties/schema/environment",
"value_type": "single_select",
"required": true,
"default_value": "production",
"description": "Prod or dev environment",
"allowed_values": [
"production",
"development"
],
"values_editable_by": "org_actors"
},
{
"property_name": "service",
"url": "https://HOSTNAME/orgs/github/properties/schema/service",
"value_type": "string"
},
{
"property_name": "team",
"url": "https://HOSTNAME/orgs/github/properties/schema/team",
"value_type": "string",
"description": "Team owning the repository"
}
]
Get a custom property for an organization
Gets a custom property that is defined for an organization. Organization members can read these properties.
Tokens de acesso refinados para "Get a custom property for an organization"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Custom properties" organization permissions (read)
Parâmetros para "Get a custom property for an organization"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
custom_property_name string ObrigatórioThe custom property name |
Códigos de status de resposta HTTP para "Get a custom property for an organization"
Código de status | Descrição |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Get a custom property for an organization"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/properties/schema/CUSTOM_PROPERTY_NAME
Response
Status: 200
{
"property_name": "environment",
"url": "https://HOSTNAME/orgs/github/properties/schema/environment",
"value_type": "single_select",
"required": true,
"default_value": "production",
"description": "Prod or dev environment",
"allowed_values": [
"production",
"development"
]
}
Create or update a custom property for an organization
Creates a new or updates an existing custom property that is defined for an organization.
To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of
custom_properties_org_definitions_manager
in the organization.
Tokens de acesso refinados para "Create or update a custom property for an organization"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Custom properties" organization permissions (admin)
Parâmetros para "Create or update a custom property for an organization"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
custom_property_name string ObrigatórioThe custom property name |
Nome, Tipo, Descrição |
---|
value_type string ObrigatórioThe type of the value for the property Pode ser um dos: |
required boolean Whether the property is required. |
default_value null or string or array Default value of the property |
description string or null Short description of the property |
allowed_values array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values. |
Códigos de status de resposta HTTP para "Create or update a custom property for an organization"
Código de status | Descrição |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Create or update a custom property for an organization"
Exemplo de solicitação
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/properties/schema/CUSTOM_PROPERTY_NAME \
-d '{"value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"]}'
Response
Status: 200
{
"property_name": "environment",
"url": "https://HOSTNAME/orgs/github/properties/schema/environment",
"value_type": "single_select",
"required": true,
"default_value": "production",
"description": "Prod or dev environment",
"allowed_values": [
"production",
"development"
]
}
Remove a custom property for an organization
Removes a custom property that is defined for an organization.
To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of
custom_properties_org_definitions_manager
in the organization.
Tokens de acesso refinados para "Remove a custom property for an organization"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Custom properties" organization permissions (admin)
Parâmetros para "Remove a custom property for an organization"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
custom_property_name string ObrigatórioThe custom property name |
Códigos de status de resposta HTTP para "Remove a custom property for an organization"
Código de status | Descrição |
---|---|
204 | A header with no content is returned. |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "Remove a custom property for an organization"
Exemplo de solicitação
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/properties/schema/CUSTOM_PROPERTY_NAME
A header with no content is returned.
Status: 204
List custom property values for organization repositories
Lists organization repositories with all of their custom property values. Organization members can read these properties.
Tokens de acesso refinados para "List custom property values for organization repositories"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Custom properties" organization permissions (read)
Parâmetros para "List custom property values for organization repositories"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Tipo, Descrição |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: |
repository_query string Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers. |
Códigos de status de resposta HTTP para "List custom property values for organization repositories"
Código de status | Descrição |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Exemplos de código para "List custom property values for organization repositories"
Exemplo de solicitação
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/properties/values
Response
Status: 200
[
{
"repository_id": 1296269,
"repository_name": "Hello-World",
"repository_full_name": "octocat/Hello-World",
"properties": [
{
"property_name": "environment",
"value": "production"
},
{
"property_name": "service",
"value": "web"
},
{
"property_name": "team",
"value": "octocat"
}
]
}
]
Create or update custom property values for organization repositories
Create new or update existing custom property values for repositories in a batch that belong to an organization. Each target repository will have its custom property values updated to match the values provided in the request.
A maximum of 30 repositories can be updated in a single request.
Using a value of null
for a custom property will remove or 'unset' the property value from the repository.
To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of
custom_properties_org_values_editor
in the organization.
Tokens de acesso refinados para "Create or update custom property values for organization repositories"
Esse ponto de extremidade funciona com os seguintes tipos de token refinados:
- Tokens de acesso de usuário do aplicativo GitHub
- Tokens de acesso à instalação do aplicativo GitHub
- Tokens de acesso pessoal refinados
O token refinado deve ter os seguintes conjuntos de permissões:
- "Custom properties" organization permissions (write)
Parâmetros para "Create or update custom property values for organization repositories"
Nome, Tipo, Descrição |
---|
accept string Setting to |
Nome, Tipo, Descrição |
---|
org string ObrigatórioThe organization name. The name is not case sensitive. |
Nome, Tipo, Descrição | |||
---|---|---|---|
repository_names array of strings ObrigatórioThe names of repositories that the custom property values will be applied to. | |||
properties array of objects ObrigatórioList of custom property names and associated values to apply to the repositories. | |||
Properties of |
Nome, Tipo, Descrição |
---|
property_name string ObrigatórioThe name of the property |
value null or string or array ObrigatórioThe value assigned to the property |
Códigos de status de resposta HTTP para "Create or update custom property values for organization repositories"
Código de status | Descrição |
---|---|
204 | No Content when custom property values are successfully created or updated |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Create or update custom property values for organization repositories"
Exemplo de solicitação
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/orgs/ORG/properties/values \
-d '{"repository_names":["Hello-World","octo-repo"],"properties":[{"property_name":"environment","value":"production"},{"property_name":"service","value":"web"},{"property_name":"team","value":"octocat"}]}'
No Content when custom property values are successfully created or updated
Status: 204