Puntos de conexión de la API de REST para propiedades personalizadas
Usa la API de REST para crear y administrar propiedades personalizadas para una organización.
Acerca de las propiedades personalizadas
Puedes usar la API de REST para crear y administrar organizaciones. Puedes usar propiedades personalizadas para añadir metadatos a los repositorios de tu organización. Para obtener más información, vea «Administración de propiedades personalizadas para repositorios de la organización».
Get all custom properties for an organization
Gets all custom properties defined for an organization. Organization members can read these properties.
Tokens de acceso específicos para "Get all custom properties for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Custom properties" organization permissions (read)
Parámetros para "Get all custom properties for an organization"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
Códigos de estado de respuesta HTTP para "Get all custom properties for an organization"
status code | Descripción |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Get all custom properties for an organization"
Ejemplo de solicitud
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 acceso específicos para "Create or update custom properties for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Custom properties" organization permissions (admin)
Parámetros para "Create or update custom properties for an organization"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
Nombre, Tipo, Descripción | |||||||||
---|---|---|---|---|---|---|---|---|---|
properties array of objects RequeridoThe array of custom properties to create or update. | |||||||||
Properties of |
Nombre, Tipo, Descripción |
---|
property_name string RequeridoThe 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 RequeridoThe type of the value for the property Puede ser uno de los siguientes: |
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 Puede ser uno de los siguientes: |
Códigos de estado de respuesta HTTP para "Create or update custom properties for an organization"
status code | Descripción |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Create or update custom properties for an organization"
Ejemplo de solicitud
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 acceso específicos para "Get a custom property for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Custom properties" organization permissions (read)
Parámetros para "Get a custom property for an organization"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
custom_property_name string RequeridoThe custom property name |
Códigos de estado de respuesta HTTP para "Get a custom property for an organization"
status code | Descripción |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Get a custom property for an organization"
Ejemplo de solicitud
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 acceso específicos para "Create or update a custom property for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Custom properties" organization permissions (admin)
Parámetros para "Create or update a custom property for an organization"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
custom_property_name string RequeridoThe custom property name |
Nombre, Tipo, Descripción |
---|
value_type string RequeridoThe type of the value for the property Puede ser uno de los siguientes: |
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 estado de respuesta HTTP para "Create or update a custom property for an organization"
status code | Descripción |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Create or update a custom property for an organization"
Ejemplo de solicitud
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 acceso específicos para "Remove a custom property for an organization"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Custom properties" organization permissions (admin)
Parámetros para "Remove a custom property for an organization"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
custom_property_name string RequeridoThe custom property name |
Códigos de estado de respuesta HTTP para "Remove a custom property for an organization"
status code | Descripción |
---|---|
204 | A header with no content is returned. |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Remove a custom property for an organization"
Ejemplo de solicitud
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 acceso específicos para "List custom property values for organization repositories"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Custom properties" organization permissions (read)
Parámetros para "List custom property values for organization repositories"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
Nombre, Tipo, Descripción |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
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 estado de respuesta HTTP para "List custom property values for organization repositories"
status code | Descripción |
---|---|
200 | OK |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "List custom property values for organization repositories"
Ejemplo de solicitud
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 acceso específicos para "Create or update custom property values for organization repositories"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "Custom properties" organization permissions (write)
Parámetros para "Create or update custom property values for organization repositories"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
org string RequeridoThe organization name. The name is not case sensitive. |
Nombre, Tipo, Descripción | |||
---|---|---|---|
repository_names array of strings RequeridoThe names of repositories that the custom property values will be applied to. | |||
properties array of objects RequeridoList of custom property names and associated values to apply to the repositories. | |||
Properties of |
Nombre, Tipo, Descripción |
---|
property_name string RequeridoThe name of the property |
value null or string or array RequeridoThe value assigned to the property |
Códigos de estado de respuesta HTTP para "Create or update custom property values for organization repositories"
status code | Descripción |
---|---|
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. |
Ejemplos de código para "Create or update custom property values for organization repositories"
Ejemplo de solicitud
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