Skip to main content

Enterprise Server 3.21 actualmente está disponible como versión candidata para lanzamiento.

Ahora la API REST está versionada. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API REST para los valores de propiedad personalizados de una organización

Uso de la API REST para administrar valores de propiedad personalizados para una organización

Get all custom property values for an organization

Gets all custom property values that are set for an organization.

The organization must belong to an enterprise.

Access requirements:

  • Organization admins
  • OAuth tokens and personal access tokens (classic) with the read:org scope
  • Actors with the organization-level "read custom properties for an organization" fine-grained permission or above

Fine-grained access tokens for "Get all custom property values for an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Custom properties for organizations" organization permissions (read)

Parámetros para "Get all custom property values for an organization"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
org string Obligatorio

The organization name. The name is not case sensitive.

HTTP response status codes for "Get all custom property values for an organization"

Status codeDescripción
200

OK

403

Forbidden

404

Resource not found

Code samples for "Get all custom property values for an organization"

Request example

get/organizations/{org}/org-properties/values
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ http(s)://HOSTNAME/api/v3/organizations/ORG/org-properties/values

Response

Status: 200
[ { "property_name": "environment", "value": "production" }, { "property_name": "service", "value": "web" }, { "property_name": "team", "value": "octocat" } ]

Create or update custom property values for an organization

Create new or update existing custom property values for an organization. To remove a custom property value from an organization, set the property value to null.

The organization must belong to an enterprise.

Access requirements:

  • Organization admins
  • OAuth tokens and personal access tokens (classic) with the admin:org scope
  • Actors with the organization-level "edit custom properties for an organization" fine-grained permission

Fine-grained access tokens for "Create or update custom property values for an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

  • "Custom properties for organizations" organization permissions (write)

Parámetros para "Create or update custom property values for an organization"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
org string Obligatorio

The organization name. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
properties array of objects Obligatorio

A list of custom property names and associated values to apply to the organization.

Nombre, Tipo, Descripción
property_name string Obligatorio

The name of the property

value null or string or array Obligatorio

The value assigned to the property

HTTP response status codes for "Create or update custom property values for an organization"

Status codeDescripció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.

Code samples for "Create or update custom property values for an organization"

Request example

patch/organizations/{org}/org-properties/values
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2026-03-10" \ http(s)://HOSTNAME/api/v3/organizations/ORG/org-properties/values \ -d '{"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