GitHub

Parámetros de entrada

• invitation_idintegerObligatorio

  Unique identifier of the repository invitation. Obtain by listing pending invitations for the authenticated user.

Parámetros de salida

• dataobjectObligatorio

  GitHub API response. Usually empty for a successful acceptance (HTTP 204 No Content status).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of results (starts from 1).

• sortstringenum

  Sorts starred repositories by 'created' (date starred) or 'updated' (date last pushed).

  createdupdated
• per_pageinteger

  Number of results per page (max 100).

• directionstringenum

  Sort direction: 'asc' (ascending) or 'desc' (descending).

  ascdesc

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of the results to fetch.

• repostringObligatorio

  Name of the repository, without the `.git` extension; case-insensitive.

• ownerstringObligatorio

  Username of the account owner (user or organization) of the repository; case-insensitive.

• per_pageinteger

  Number of results to display per page (max 100).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username of the account that owns the repository. This field is not case-sensitive.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response data. Upon a successful star operation (HTTP 204 No Content), this field will typically be an empty dictionary or not populated.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailsstring[]Obligatorio

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is not case-sensitive.

• branchstringObligatorio

  The name of the branch to which restrictions will be applied. Wildcard characters (e.g., '*') are not allowed in the branch name when using this REST API endpoint. For operations involving wildcard branch names, consult the GitHub GraphQL API.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. This name is not case sensitive.

• usernamestringObligatorio

  The GitHub handle for the user account to add as a collaborator.

• permissionstring

  Permission level for the collaborator. For organization-owned repositories, valid values are `pull` (read-only), `triage` (manage issues/PRs), `push` (read/write), `maintain` (manage most settings), `admin` (full control), or a custom repository role name if defined by the owning organization. This parameter is ignored for personal repositories, which grant `push` access.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repository_idintegerObligatorio

  The unique identifier of the repository to add to the installation. The authenticated user must have admin permissions for this repository.

• installation_idintegerObligatorio

  The unique identifier of the GitHub App installation to which the repository will be added. This installation must be accessible to the authenticated user.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• secret_namestringObligatorio

  Name of the user-level Codespaces secret to which repository access is added; this secret must already exist for the authenticated user.

• repository_idintegerObligatorio

  The unique identifier of the repository to be granted access to the specified user-level Codespaces secret.

Parámetros de salida

• dataobjectObligatorio

  The response data from the API. On successful execution (HTTP 204 No Content), this field is typically empty.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case sensitive.

• ownerstringObligatorio

  The username of the account or the organization name that owns the repository. This field is not case sensitive.

• assigneesstring[]

  A list of GitHub usernames to assign to the issue. Up to 10 assignees can be specified. Pass an empty list `[]` to remove all current assignees. _NOTE: The authenticated user must have push access to the repository to modify assignees. If the user lacks this permission, changes to assignees will be silently ignored._

• issue_numberintegerObligatorio

  The unique number identifying the issue within the repository.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response data, typically representing the full issue object with its updated list of assignees.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Repository name, without the `.git` extension (case-insensitive).

• ownerstringObligatorio

  Username or organization name owning the repository (case-insensitive).

• issue_numberintegerObligatorio

  Number that uniquely identifies the issue within the repository.

Parámetros de salida

• dataobjectObligatorio

  The API response data, which includes all labels currently applied to the issue.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The organization's name (case-insensitive).

• labelsstring[]Obligatorio

  A list of custom label names to add to the self-hosted runner. Previously applied labels are not removed.

• runner_idintegerObligatorio

  Unique identifier of the self-hosted runner.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the updated list of labels for the runner. This typically includes a 'total_count' of labels and a 'labels' array, where each element is an object detailing a label (e.g., its ID, name, and type).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the GitHub organization. This name is not case-sensitive.

• rolestringenum

  The role to assign to the user within the team. A 'maintainer' has broader permissions than a 'member', such as managing team members and settings.

  membermaintainer
• usernamestringObligatorio

  The GitHub username of the user to add or whose membership to update.

• team_slugstringObligatorio

  The slug (URL-friendly version) of the team's name.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the team membership details for the user, including their role and current membership state (e.g., 'active', 'pending').

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the organization (case-insensitive).

• team_slugstringObligatorio

  URL-friendly identifier (slug) for the team.

• permissionstringenum

  Permission level to grant ('read', 'write', or 'admin'). Uses the team's default permission if not provided.

  readwriteadmin
• project_idintegerObligatorio

  Unique identifier of the project.

Parámetros de salida

• dataobject

  Response data. A successful update (HTTP 204 No Content) typically results in an empty body.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Organization's name (case-insensitive).

• repostringObligatorio

  Repository name, without the `.git` extension (case-insensitive).

• ownerstringObligatorio

  Username of the account owning the repository (case-insensitive).

• team_slugstringObligatorio

  The team's slug (URL-friendly name).

• permissionstring

  Permission to grant the team. Options: 'pull' (read-only), 'triage' (manage issues/PRs), 'push' (read/write), 'maintain' (manage repo settings, plus push), 'admin' (full control), or a custom repository role name.

Parámetros de salida

• dataobject

  API response data. Usually an empty dictionary for successful updates (HTTP 204 No Content).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  The GitHub username of the user to be added as a collaborator.

• permissionstringenum

  Permission level for the collaborator on the project.

  readwriteadmin
• project_idintegerObligatorio

  The unique identifier of the organization project.

Parámetros de salida

• dataobjectObligatorio

  API response data; typically empty on success (204 No Content).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the GitHub organization. This field is not case-sensitive.

• secret_namestringObligatorio

  The name of the organization secret to which the repository will be added.

• repository_idintegerObligatorio

  The unique identifier of the repository to be granted access to the organization secret.

Parámetros de salida

• dataobjectObligatorio

  Response data from the API. For a successful operation (which typically returns a 204 No Content status), this field will likely be empty. In case of an error, it may contain error details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The organization's unique identifier (case-insensitive).

• secret_namestringObligatorio

  Name of the Dependabot secret; must be alphanumeric or underscore, no spaces (lowercase auto-converts to uppercase).

• repository_idintegerObligatorio

  Unique ID of the repository to be granted access to the secret.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Name of the repository, without the `.git` extension. Case-insensitive.

• ownerstringObligatorio

  Username or organization name of the repository owner. Case-insensitive.

• labelsstring[]Obligatorio

  Custom label names to add. Appended to existing labels. Names are case-insensitive. Empty list means no changes.

• runner_idintegerObligatorio

  Unique ID of the self-hosted runner.

Parámetros de salida

• dataobjectObligatorio

  Details of all custom labels on the runner after addition, typically including `total_count` and a list of label objects (each with `id`, `name`, `type`).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the organization. This name is not case sensitive.

• secret_namestringObligatorio

  The name of the secret. Secret names can only contain alphanumeric characters ([A-Z], [a-z], [0-9]) or underscores (_). Spaces are not allowed. Secret names cannot start with GITHUB_ and must be less than 255 characters.

• repository_idintegerObligatorio

  The unique identifier of the repository to add to the secret's access list.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary, as this operation does not return a response body on success (HTTP 204 No Content).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the GitHub organization (case-insensitive).

• namestringObligatorio

  Name of the existing organization-level GitHub Actions variable.

• repository_idintegerObligatorio

  Unique identifier of the repository to grant access.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• account_urlsstring[]Obligatorio

  Full URLs for social media profiles to add to the user's GitHub profile; these will be displayed publicly.

Parámetros de salida

• dataobjectObligatorio

  Details of social media accounts successfully added to the authenticated user's profile, typically including platform and URL for each.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. This name is not case sensitive.

• branchstringObligatorio

  The name of the branch to which status check contexts will be added. Branch names cannot contain wildcard characters. To use wildcard characters in branch names, refer to [the GraphQL API](https://docs.github.com/graphql).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This value is not case-sensitive.

• ownerstringObligatorio

  The GitHub username or organization name that owns the repository. This value is not case-sensitive.

• branchstringObligatorio

  The name of the branch to apply restrictions to. Wildcard characters are not supported for this field. To use wildcard characters in branch names, please consult the GitHub GraphQL API (see https://docs.github.com/graphql).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case-sensitive.

• ownerstringObligatorio

  The account owner of the repository. This name is not case-sensitive.

• branchstringObligatorio

  The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, refer to the GitHub GraphQL API documentation.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Organization's name (case-insensitive).

• selected_usernamesstring[]Obligatorio

  Usernames of organization members to be granted Codespaces access billed to the organization. These users must be members of the specified organization.

Parámetros de salida

• dataobjectObligatorio

  API response. May be empty or absent on success (e.g., HTTP 204), or contain error details on failure.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository without the `.git` extension. The name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. The name is not case sensitive.

• run_idintegerObligatorio

  The unique identifier of the workflow run requiring approval.

Parámetros de salida

• dataobjectObligatorio

  An empty object indicating success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the GitHub organization. This field is case-insensitive.

• role_idintegerObligatorio

  Unique identifier of the organization role to assign to the team (obtainable by listing organization roles).

• team_slugstringObligatorio

  The slug (URL-friendly version) of the team's name.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary if the role was assigned successfully. GitHub API returns a 204 No Content status on success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The organization's name. This is not case-sensitive.

• role_idintegerObligatorio

  The unique integer identifier for the organization role. This ID can be obtained by listing the organization's roles.

• usernamestringObligatorio

  The GitHub username of the user to whom the role will be assigned.

Parámetros de salida

• dataobjectObligatorio

  A dictionary that is typically empty upon successful role assignment, as the GitHub API returns a 204 No Content status for this operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  List of the authenticated user's Docker packages that experienced conflicts during migration, including details for each.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  Case-sensitive GitHub username of the user to block.

Parámetros de salida

• dataobject

  Response data from the GitHub API; typically empty on success (HTTP 204 No Content), but populated for other response codes.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The case-insensitive name of the GitHub organization.

• usernamestringObligatorio

  The GitHub username (handle) of the account to block.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response data from the API. For a successful block operation (HTTP 204 No Content), this dictionary is typically empty.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Repository name, excluding the `.git` extension. Not case-sensitive.

• ownerstringObligatorio

  Username or organization that owns the repository. Not case-sensitive.

• pages_deployment_idintegerObligatorio

  Unique numerical ID of the GitHub Pages deployment (not the commit SHA).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension (not case-sensitive).

• ownerstringObligatorio

  The account owner of the repository (not case-sensitive).

• run_idintegerObligatorio

  Unique identifier of the workflow run.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• client_idstringObligatorio

  The unique client ID of the GitHub App for which the token was issued.

• access_tokenstringObligatorio

  The OAuth or GitHub App access token that needs to be checked for validity.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing details of the validated token if it is valid. Key information includes `id`, `url`, `app` (details of the GitHub App), `token` (the token string), `user` (if a user token), `scopes`, `permissions`, `created_at`, `updated_at`, and `expires_at` (if applicable).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• gist_idstringObligatorio

  The ID of the Gist to check.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  The GitHub username (e.g., 'octocat') of the person to check. This is the user's handle on GitHub.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension (not case sensitive).

• ownerstringObligatorio

  The account owner of the repository (not case sensitive).

• pull_numberintegerObligatorio

  The number that identifies the pull request.

Parámetros de salida

• dataobjectObligatorio

  API response data. Merge status is indicated by HTTP status: 204 (merged, empty body) or 404 (not merged/found, body may contain error details).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository (e.g., a user or organization). This name is not case sensitive.

Parámetros de salida

• dataobjectObligatorio

  Empty dictionary if the repository is starred by the authenticated user (signified by an HTTP 204 No Content from GitHub API). If not starred or if the repository doesn't exist, an API error (e.g., HTTP 404) is raised, and this response is not populated.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository (e.g., a GitHub username or organization name). This name is not case sensitive.

• assigneestringObligatorio

  The GitHub username of the user to check for assignability. This name is not case sensitive.

Parámetros de salida

• dataobjectObligatorio

  API response data. Typically empty if the user can be assigned (HTTP 204 No Content).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username of the account owning the repository. This field is not case-sensitive.

• assigneestringObligatorio

  The GitHub username of the user to check for assignment permissions.

• issue_numberintegerObligatorio

  The unique number identifying the issue within the repository.

Parámetros de salida

• dataobjectObligatorio

  Empty if the user can be assigned; otherwise, contains GitHub error details if the user cannot be assigned or if the issue/repository is not found.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  The GitHub username of the user to check.

• target_userstringObligatorio

  The GitHub username of the user to verify if they are followed by the `username`.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary. The follow status is determined by the HTTP response code (204 for following, 404 for not following), not the content of this field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository, typically a GitHub username or an organization name. This name is not case sensitive.

• usernamestringObligatorio

  The GitHub username of the user whose collaborator status is being checked. This name is not case sensitive.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The organization's GitHub name. This name is not case-sensitive.

• usernamestringObligatorio

  The GitHub username of the user to check.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• usernamestringObligatorio

  The GitHub username (handle) of the user.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary, returned when the API signals the user is blocked (204 No Content). This model is not used if the user is not blocked (API returns 404 Not Found).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is not case-sensitive.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing a boolean field `enabled` which is `true` if private vulnerability reporting is enabled for the repository, and `false` otherwise.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the organization. This is case-insensitive.

• team_slugstringObligatorio

  The slug (short name) of the team.

• project_idintegerObligatorio

  The unique identifier of the project (classic).

Parámetros de salida

• dataobjectObligatorio

  Details of the classic project, returned if the team has 'read', 'write', or 'admin' permissions. Includes project URLs, owner information, and other attributes.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the organization. This field is not case-sensitive.

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The organization that owns the repository. For this GitHub API endpoint, this value must be the same as the `org` parameter. This field is not case-sensitive.

• team_slugstringObligatorio

  The URL-friendly slug for the team name. It is unique within the organization and typically all lowercase with hyphens instead of spaces.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the repository object, which includes the team's permissions for it. Key information includes a `permissions` attribute with boolean flags for `admin`, `maintain`, `push`, `triage`, and `pull` access.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• keystringObligatorio

  The exact cache key used to identify specific caches for deletion. This key is often dynamically generated in workflows using expressions (e.g., `${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}`).

• refstring

  The full Git reference for narrowing down the cache deletion. For example, to target caches for a specific branch, use `refs/heads/<branch_name>`. To target caches for a pull request, use `refs/pull/<pull_number>/merge`. If omitted, caches matching the key across all refs are considered.

• repostringObligatorio

  The name of the repository without the `.git` extension. The name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. The name is not case sensitive.

Parámetros de salida

• dataobjectObligatorio

  A dictionary typically containing `total_count`, the number of caches deleted, and `actions_caches`, an array of the deleted cache objects.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the organization (case-insensitive).

• runner_idintegerObligatorio

  Unique identifier of the self-hosted runner.

Parámetros de salida

• dataobjectObligatorio

  Dictionary with the total count and list of remaining labels after clearing custom ones; GitHub-assigned default labels are not removed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page number of the results to fetch, for pagination when the number of differences (commits or files) is large.

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is not case-sensitive.

• baseheadstringObligatorio

  A string specifying the base and head references to compare, in the format `BASE...HEAD`. `BASE` and `HEAD` can be branch names (e.g., `main...develop`), tag names (e.g., `v1.0.0...v1.1.0`), or commit SHA-1s. Both references must exist in the specified repository. To compare branches across forks in the same network, use the format `OWNER:REF...OWNER:REF` (e.g., `octocat:main...another-user:main`).

• per_pageinteger

  Number of results (e.g., files or commits) to return per page, with a maximum of 100, for pagination.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the comparison details. This typically includes: the status of the comparison (e.g., 'diverged', 'ahead', 'behind', 'identical'), the number of commits `ahead_by` and `behind_by` the base, `total_commits` in the range, an array of `commits` objects, an array of `files` objects detailing changed files (including status, additions, deletions, changes, patch, etc.), and various URLs (`html_url`, `permalink_url`, `diff_url`, `patch_url`) for accessing the comparison.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the GitHub organization (case-insensitive).

• namestringObligatorio

  Desired name for the new self-hosted runner, visible in the GitHub UI.

• labelsstring[]Obligatorio

  Custom labels to assign to the new self-hosted runner, used by GitHub Actions to route jobs. **Minimum items**: 1. **Maximum items**: 100.

• work_folderstring

  Path to the working directory on the runner machine where jobs will execute, relative to the runner's installation directory.

• runner_group_idintegerObligatorio

  ID of the runner group to assign the new self-hosted runner. Must exist in the organization.

Parámetros de salida

• dataobjectObligatorio

  Generated JIT configuration. Includes `runner` details (like `id`, `name`, `os`, `status`, `labels`) and `encoded_jit_config` (base64 encoded string for runner registration with GitHub Actions).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The GitHub organization name (case-insensitive).

• include_claim_keysstring[]Obligatorio

  Array of unique strings, each a valid claim key (e.g., 'repo', 'actor'; alphanumeric/underscores only), to include in the OIDC subject claim (`sub`).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The organization name (case-insensitive).

• asyncboolean

  If true, performs the conversion asynchronously (API returns a 202 status when the job is successfully queued).

• usernamestringObligatorio

  The GitHub username of the member to convert.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the '.git' extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is not case-sensitive.

• contentstringObligatorio

  The content to be stored in the new blob.

• encodingstring

  The encoding for the 'content'; "utf-8" or "base64".

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the check to be displayed in the GitHub UI. For example, "Code Coverage" or "Linter".

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. This name is not case sensitive.

• statusstringenum

  The current status of the check run. Only GitHub Actions can set `status` to `waiting`, `pending`, or `requested`.

  queuedin_progresscompletedwaitingrequestedpending
• actionsobject[]

  A list of up to three action objects defining interactive buttons displayed on GitHub after the check run completes. Each object needs a `label` (button text), `identifier` (unique ID for the action), and `description` (tooltip). Clicking a button sends a `check_run.requested_action` webhook to your app.

• head_shastringObligatorio

  The SHA of the commit for which the check run is created.

• conclusionstringenum

  **Required if `completed_at` is provided or if `status` is `completed`**. Specifies the final outcome of the check (e.g., 'success', 'failure'). Note: Setting `conclusion` automatically sets `status` to `completed`. GitHub alone can set a conclusion to `stale`.

  action_requiredcancelledfailureneutralsuccessskippedstaletimed_out
• started_atstringdate-time

  The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run began.

• details_urlstring

  The URL of the integrator's site providing full details of the check. If omitted, the GitHub App's homepage is used. This URL is available from the check's UI.

• external_idstring

  A unique identifier for the check run on the integrator's system. This helps in correlating check runs between GitHub and the external system.

• completed_atstringdate-time

  The ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ) indicating when the check run finished. **Required if `status` is `completed`**.

• output__textstring

  Detailed textual information about the check run's output. Supports Markdown. **Maximum length**: 65,535 characters.

• output__titlestring

  A descriptive title for the output of the check run, displayed in the GitHub UI. For example, 'Linter Scan Summary'.

• output__imagesobject[]

  A list of image objects to display in the check run's output in the GitHub UI. Each object requires `alt` (alternative text), `image_url` (URL of the image), and an optional `caption`.

• output__summarystring

  A summary of the check run's findings. Supports Markdown. **Maximum length**: 65,535 characters.

• output__annotationsobject[]

  A list of annotation objects detailing issues at specific code locations. Annotations are visible in the 'Checks' and 'Files changed' tabs of a pull request. Each annotation object should specify `path`, `start_line`, `end_line`, `annotation_level` ('notice', 'warning', or 'failure'), and `message`. Optional fields include `start_column`, `end_column`, `title`, and `raw_details`. Up to 50 annotations per API request; for more, use subsequent 'Update a check run' calls. GitHub Actions limits are 10 warnings and 10 errors per step.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the full check run object as created by the API. This includes fields like `id`, `node_id`, `head_sha`, `status`, `conclusion`, `name`, `details_url`, `external_id`, `started_at`, `completed_at`, `output` (containing summary, text, annotations, images), `app` (information about the GitHub App that created the check run), and `pull_requests` (an array of pull requests associated with the commit).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Repository name, without the `.git` extension (case-insensitive).

• ownerstringObligatorio

  Account owner of the repository (case-insensitive).

• head_shastringObligatorio

  SHA of the commit for which to create the check suite, typically the head commit of a branch.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created check suite.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• refstring

  Git ref (branch, tag, or commit SHA) to use for the codespace.

• pull_requestobject
• repository_idinteger

  ID of the repository to create the codespace from.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• geostringenum

  Geographic area for this codespace (e.g., `UsEast`, `EuropeWest`); supersedes `location`. If unspecified, typically IP-derived.

  EuropeWestSoutheastAsiaUsEastUsWest
• repostringObligatorio

  The name of the repository, without the `.git` extension. This is case-insensitive.

• ownerstringObligatorio

  The username of the account that owns the repository. This is case-insensitive.

• machinestring

  Machine type for this codespace (e.g., `standardLinux`). Varies by CPU, RAM, storage. Uses default if unspecified.

• locationstring

  Requested geographic location (e.g., `EastUs`, `WestEurope`). This parameter is deprecated; use `geo`. If unspecified, location may be IP-derived.

• client_ipstring

  Client's public IP address for location auto-detection if proxied and `geo` or `location` are not specified.

• pull_numberintegerObligatorio

  The unique number identifying the pull request.

• display_namestring

  Custom name for the codespace.

• devcontainer_pathstring

  Path to a `devcontainer.json` file in the repository that defines the development environment.

• working_directorystring

  Working directory for the codespace upon opening. Defaults to the repository root if unspecified.

• idle_timeout_minutesinteger

  Minutes of inactivity after which the codespace is automatically stopped. A default timeout applies if unspecified.

• retention_period_minutesinteger

  Retention period in minutes (0-43200, i.e., up to 30 days) for a stopped codespace. 0 means immediate deletion.

• multi_repo_permissions_opt_outboolean

  Set to `true` to prevent GitHub from requesting additional repository permissions defined in `devcontainer.json`. Defaults to `false` (permissions will be requested).

Parámetros de salida

• dataobjectObligatorio

  Full details of the created codespace.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• geostringenum

  Geographic area for the codespace, replacing `location`; determined by user IP if not specified.

  EuropeWestSoutheastAsiaUsEastUsWest
• refstring

  Git reference (e.g., branch name) for the codespace; uses repository's default branch if not provided.

• repostringObligatorio

  Name of the repository, without the `.git` extension; not case-sensitive.

• ownerstringObligatorio

  Username or organization name owning the repository; not case-sensitive.

• machinestring

  Machine type (CPU, RAM, storage). See 'List available machine types for a repository' action for options; uses a default type if not specified.

• locationstring

  Requested AWS region (best-effort, may differ); determined by user IP if not provided. Deprecated: use `geo`.

• client_ipstring

  IP address to infer preferred region if `location` and `geo` are unspecified; useful for proxied requests.

• display_namestring

  Custom display name for the codespace; a default name is generated if not provided.

• devcontainer_pathstring

  Path to a `devcontainer.json` in the repository; uses `.devcontainer/devcontainer.json` or `devcontainer.json` at root if not specified.

• working_directorystring

  Directory to use as default when codespace opens; uses repository root if not specified.

• idle_timeout_minutesinteger

  Minutes of inactivity before codespace auto-stops; uses a default timeout if not specified.

• retention_period_minutesinteger

  Minutes an idle (stopped) codespace is retained before auto-deletion (0-43200, i.e., up to 30 days); uses a default period if not specified.

• multi_repo_permissions_opt_outboolean

  If `true`, opts out of granting multi-repository permissions from `devcontainer.json`. If unspecified or `false`, permissions are granted if requested.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Name of the repository, without the `.git` extension (case-insensitive).

• treestringObligatorio

  SHA of the tree object for this commit; must exist in the repository.

• ownerstringObligatorio

  Account owner of the repository (case-insensitive).

• messagestringObligatorio

  The commit message.

• parentsstring[]

  SHAs of parent commits; all must exist in the repository. Omit or provide an empty list for a root commit.

• signaturestring

  ASCII-armored detached PGP signature over the commit data. GitHub adds this to the `gpgsig` header if provided.

• author__datestringdate-time

  Timestamp (ISO 8601: `YYYY-MM-DDTHH:MM:SSZ`) when the commit was authored.

• author__namestring

  Name of the commit's author. Defaults to authenticated user if not provided.

• author__emailstring

  Email of the commit's author. Defaults to authenticated user if not provided.

• committer__datestringdate-time

  Timestamp (ISO 8601: `YYYY-MM-DDTHH:MM:SSZ`) when the commit was committed. Defaults to `author_date` or current time.

• committer__namestring

  Name of the committer. Defaults to author's name or authenticated user if not provided.

• committer__emailstring

  Email of the committer. Defaults to author's email or authenticated user if not provided.

Parámetros de salida

• dataobjectObligatorio

  Details of the created commit, including SHA, URL, author/committer info, tree, message, parents, and verification status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystringObligatorio

  The text content of the comment.

• lineinteger

  **Deprecated:** Use `position` instead. Line number in the file to comment on. `position` takes precedence if both are provided.

• pathstring

  Relative path of the file to comment on. If specified, `position` is also required.

• repostringObligatorio

  The name of the repository, without the `.git` extension.

• ownerstringObligatorio

  The username or organization name that owns the repository.

• positioninteger

  Line number in the diff's patch to comment on, relative to the commit's changes. Required if `path` is specified.

• commit_shastringObligatorio

  The SHA identifier of the commit to comment on.

Parámetros de salida

• dataobjectObligatorio

  Full representation of the newly created commit comment.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• shastringObligatorio

  SHA hash of the commit.

• repostringObligatorio

  Repository name, without the `.git` extension (case-insensitive).

• ownerstringObligatorio

  Username or organization name of the repository owner (case-insensitive).

• statestringObligatorioenum

  State of the commit status, indicating check outcome or phase.

  errorfailurependingsuccess
• contextstring

  Label to differentiate this status from other systems (e.g., 'ci/jenkins'); case-insensitive.

• target_urlstring

  URL linking to the source of the status (e.g., CI build log), displayed in GitHub UI.

• descriptionstring

  Human-readable description of the status, displayed in GitHub UI.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the GitHub organization (case-insensitive) where the custom role will be created.

• namestringObligatorio

  Unique name for the custom role.

• descriptionstring

  Optional short description of the custom role's purpose or permissions.

• permissionsstring[]Obligatorio

  List of permission strings defining actions granted by this role; see GitHub docs for available permissions.

Parámetros de salida

• dataobjectObligatorio

  Details of the created custom role, including `id`, `name`, `description`, `permissions`, and `organization`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• keystringObligatorio

  The full public SSH key. Ensure this is the public key, not the private key.

• repostringObligatorio

  The name of the repository, without the `.git` extension. This is not case sensitive.

• ownerstringObligatorio

  The username of the account that owns the repository. This is not case sensitive.

• titlestring

  A descriptive name for the new deploy key. If not provided, a default name will be generated.

• read_onlyboolean

  If `true`, the deploy key will only have read access. If `false` (default), the key will have read and write access. Write access grants significant privileges.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• refstringObligatorio

  The ref to deploy. This can be a branch name, a tag name, or a commit SHA.

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case-sensitive.

• taskstring

  Specifies a task to execute, e.g., `deploy` or `deploy:migrations`.

• ownerstringObligatorio

  The account owner of the repository. This name is not case-sensitive.

• payloadstring

  A JSON string payload providing additional information that a deployment system might need, customizable based on the deployment process.

• auto_mergeboolean

  Attempts to automatically merge the default branch into the requested ref if the ref is behind the default branch. Set to `false` to disable.

• descriptionstring

  A short description of the deployment. Maximum length of 1000 characters.

• environmentstring

  Name for the target deployment environment (e.g., `production`, `staging`, `qa`).

• required_contextsstring[]

  A list of status check contexts to verify against commit status checks before creating the deployment. If omitted or `null`, GitHub verifies all unique contexts. Pass an empty list `[]` to bypass all checks.

• transient_environmentboolean

  Specifies if the given environment is specific to this deployment and will no longer exist at some point in the future (e.g., a staging environment for a pull request). Set to `true` if the environment is temporary.

• production_environmentboolean

  Specifies if the given environment is one that end-users directly interact with.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the created deployment object as returned by the GitHub API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name pattern for deployable branches/tags (Ruby File.fnmatch syntax; `*` won't match `/`, e.g., `release/*/*` for `release/feature/login`). Refer to [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).

• repostringObligatorio

  Name of the repository, without the `.git` extension (not case sensitive).

• typestringenum

  Whether the policy targets a Git branch or a tag.

  branchtag
• ownerstringObligatorio

  Account owner of the repository (not case sensitive).

• environment_namestringObligatorio

  Name of the target environment; URL-encode special characters (e.g., `/` as `%2F`).

Parámetros de salida

• dataobjectObligatorio

  Details of the created deployment branch policy.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository without the `.git` extension. The name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. The name is not case sensitive.

• statestringObligatorioenum

  State of the status. Setting a transient deployment to `inactive` shows it as `destroyed` in GitHub.

  errorfailureinactivein_progressqueuedpendingsuccess
• log_urlstring

  URL for deployment output. Preferred over `target_url`; setting this also sets `target_url` to the same value.

• target_urlstring

  URL for deployment status updates or output. `log_url` is generally preferred.

• descriptionstring

  Short description of the status (max 140 characters).

• environmentstring

  Name for the target deployment environment (e.g., `production`, `staging`). If unset, uses environment from previous status or deployment.

• auto_inactiveboolean

  If true, sets prior successful, non-transient, non-production deployments in the same repository and environment to `inactive`.

• deployment_idintegerObligatorio

  The unique identifier of the deployment for which to create a status.

• environment_urlstring

  URL for accessing the target deployment environment.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the organization (not case-sensitive).

• bodystringObligatorio

  Main content of the discussion post, typically in markdown.

• titlestringObligatorio

  Title of the discussion post.

• privateboolean

  If `true`, post is private (visible only to team members, org owners, and team maintainers); `false` makes it public to all organization members.

• team_slugstringObligatorio

  URL-friendly version of the team name (slug).

Parámetros de salida

• dataobjectObligatorio

  Details of the created discussion, including ID, title, body, author, creation timestamp, and URLs.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the organization. This name is not case-sensitive.

• bodystringObligatorio

  The content of the discussion comment. Supports GitHub Flavored Markdown.

• team_slugstringObligatorio

  The slug (URL-friendly version) of the team name.

• discussion_numberintegerObligatorio

  The unique number identifying the discussion within the team.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the created discussion comment.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The desired name for the newly created fork. If not provided, the new fork will have the same name as the original repository.

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case sensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is not case sensitive.

• organizationstring

  The GitHub organization name to fork the repository into. If not specified, the fork will be created in the authenticated user's account.

• default_branch_onlyboolean

  Specifies whether to fork only the default branch of the repository. If `True`, only the default branch is copied. If `False` or not specified, all branches are copied.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the full repository object of the newly created fork. This includes details such as `id`, `node_id`, `name`, `full_name`, `html_url`, `clone_url`, `forks_url`, `commits_url`, etc.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• filesobjectObligatorio

  Content for the gist's files. Dictionary where keys are filenames and values are objects, each having a `content` key with the file's raw string data.

• publicboolean

  Indicates if the gist is public (`true`) or secret (`false`).

• descriptionstring

  Optional description for the gist.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystringObligatorio

  The text of the comment to be posted on the gist.

• gist_idstringObligatorio

  The unique identifier of the gist.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• codestringObligatorio

  The temporary code provided by GitHub during the app manifest flow. This code is exchanged for the app's configuration.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the configuration details of the newly created GitHub App. This typically includes `id`, `slug`, `node_id`, `owner`, `name`, `description`, `external_url`, `html_url`, `created_at`, `updated_at`, `permissions`, `events`, `client_id`, `client_secret`, `webhook_secret`, and `pem` (the PEM-encoded private key).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The account owner of the repository (e.g., a GitHub username or organization name). This field is not case-sensitive.

• oidc_tokenstringObligatorio

  OIDC token from GitHub Actions for deployment authorization, typically from `secrets.GITHUB_TOKEN` with `id-token: write` permission.

• artifact_idinteger

  Identifier of a GitHub Actions artifact (e.g., .zip or .tar) with static assets for deployment. Artifact must belong to the repository. Either this or `artifact_url` is required.

• environmentstring

  Target environment for this GitHub Pages deployment. Defaults to `github-pages`.

• artifact_urlstring

  URL of a GitHub Actions artifact (e.g., .zip or .tar) with static assets for deployment. Artifact must belong to the repository. Either this or `artifact_id` is required.

• pages_build_versionstring

  Unique string identifying the build version for this deployment, typically the Git commit SHA. Defaults to `GITHUB_SHA`.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the created GitHub Pages deployment, typically including the deployment URL.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the '.git' extension. This field is case-insensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is case-insensitive.

• build_typestringenum

  Build process for the Pages site: 'legacy' (traditional GitHub Pages build) or 'workflow' (GitHub Actions). If omitted and `source_branch` is provided, defaults to 'legacy'. When 'workflow', `source_branch` and `source_path` are ignored.

  legacyworkflow
• source__pathstringenum

  Directory within `source_branch` for site source files (e.g., '/' for root, '/docs'). Ignored if `build_type` is 'workflow'.

  //docs
• source__branchstring

  The branch for GitHub Pages source (e.g., 'main', 'gh-pages'). Required if `build_type` is 'legacy' or not specified. It is ignored if `build_type` is 'workflow'.

Parámetros de salida

• dataobjectObligatorio

  The GitHub Pages site configuration details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see the "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)."

• repostringObligatorio

  The name of the repository, without the `.git` extension. This is not case sensitive.

• colorstring

  The hexadecimal color code for the label (e.g., `f29513`), without the leading `#`. If not provided, GitHub will assign a random color.

• ownerstringObligatorio

  The username of the account that owns the repository. This is not case sensitive.

• descriptionstring

  A short description of the label. Maximum 100 characters.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Repository name, without the `.git` extension (case-insensitive).

• ownerstringObligatorio

  Username of the repository owner (case-insensitive).

• statestringenum

  State of the milestone.

  openclosed
• titlestringObligatorio

  Title for the new milestone.

• due_onstringdate-time

  Due date for the milestone (ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`).

• descriptionstring

  Detailed description of the milestone.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created milestone from the GitHub API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. The name is not case-sensitive.

• ownerstringObligatorio

  The account owner of the repository. This can be a username or an organization name. The name is not case-sensitive.

• key_prefixstringObligatorio

  Prefix that triggers the autolink (e.g., 'JIRA-'). When followed by an identifier, it's converted into a link. Must be non-empty and not contain spaces.

• url_templatestringObligatorio

  URL template for the autolink, using `<num>` as a placeholder for the reference identifier (e.g., 'https://example.atlassian.net/browse/<num>'). Behavior of `<num>` is determined by `is_alphanumeric`.

• is_alphanumericboolean

  Specifies if the `<num>` placeholder in `url_template` matches alphanumeric characters (`A-Z` (case-insensitive), `0-9`, and `-`) or only numeric characters (`0-9`).

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the autolink reference object that was created. This typically includes fields such as `id`, `key_prefix`, `url_template`, and `is_alphanumeric`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the environment variable to create (e.g., `API_KEY`).

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is not case-sensitive.

• valuestringObligatorio

  The value of the environment variable (e.g., `your_secret_token`). This value will be encrypted.

• environment_namestringObligatorio

  The name of the environment for which to create the variable. The name must be URL encoded if it contains special characters (e.g., slashes `/` must be replaced with `%2F`).

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary is returned upon successful creation of the environment variable (HTTP 201 Created).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystring

  The detailed textual contents of the new issue.

• repostringObligatorio

  The name of the repository, without the `.git` extension (case-insensitive).

• ownerstringObligatorio

  The GitHub account owner of the repository (case-insensitive).

• titlestringObligatorio

  The title for the new issue.

• labelsstring[]

  Label names to associate with this issue (generally case-insensitive). NOTE: Only users with push access can set labels; they are silently dropped otherwise. Pass an empty list to clear all labels.

• assigneestring

  Login for the user to whom this issue should be assigned. NOTE: Only users with push access can set the assignee; it is silently dropped otherwise. **This field is deprecated in favor of `assignees`.**

• assigneesstring[]

  GitHub login names for users to assign to this issue. NOTE: Only users with push access can set assignees; they are silently dropped otherwise.

• milestonestring

  The ID of the milestone to associate this issue with (e.g., "5"). NOTE: Only users with push access can set the milestone; it is silently dropped otherwise.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full data representation of the newly created GitHub issue, including its ID, title, body, state, assignees, labels, etc.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystringObligatorio

  Comment content in GitHub Flavored Markdown.

• repostringObligatorio

  Name of the repository (without `.git` extension); not case-sensitive.

• ownerstringObligatorio

  Account owner of the repository (username or organization); not case-sensitive.

• issue_numberintegerObligatorio

  Number identifying the issue or pull request for the comment.

Parámetros de salida

• dataobjectObligatorio

  Full API response for the created issue comment, including ID, author, body, and timestamps.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the organization (not case-sensitive).

• bodystring

  Body or description for the new project.

• namestringObligatorio

  Name for the new project.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created classic organization project.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Name of the organization where the repository will be created (case-insensitive).

• namestringObligatorio

  Name of the new repository.

• privateboolean

  Whether the repository is private. `visibility` takes precedence if both are set.

• team_idinteger

  ID of the team to grant access to this repository within the organization.

• has_wikiboolean

  Enable wiki for this repository.

• homepagestring

  URL for the repository's homepage.

• auto_initboolean

  Create an initial commit with an empty README.

• has_issuesboolean

  Enable issues for this repository.

• visibilitystringenum

  Repository visibility: 'public' (visible to everyone) or 'private' (visible to collaborators).

  publicprivate
• descriptionstring

  Short description of the repository.

• is_templateboolean

  Make this repository a template repository.

• has_projectsboolean

  Enable projects for this repository. Fails if organization has disabled repository projects and this is true.

• has_downloadsboolean

  Enable downloads for this repository (deprecated).

• allow_auto_mergeboolean

  Allow auto-merge on pull requests.

• license_templatestring

  License template keyword (e.g., "mit", "apache-2.0"). See [GitHub license documentation](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) for options.

• custom_propertiesobject

  Custom properties for the repository as a key-value dictionary.

• allow_merge_commitboolean

  Allow merging pull requests with a merge commit.

• allow_rebase_mergeboolean

  Allow rebase-merging pull requests.

• allow_squash_mergeboolean

  Allow squash-merging pull requests.

• gitignore_templatestring

  Name of the .gitignore template to apply (e.g., "Python", "Node"). Refer to the [GitHub gitignore template list](https://github.com/github/gitignore).

• merge_commit_titlestringenum

  Default title for merge commits: 'PR_TITLE' or 'MERGE_MESSAGE'.

  PR_TITLEMERGE_MESSAGE
• merge_commit_messagestringenum

  Default message for merge commits: 'PR_TITLE', 'PR_BODY', or 'BLANK'.

  PR_BODYPR_TITLEBLANK
• delete_branch_on_mergeboolean

  Automatically delete head branches when pull requests are merged. Requires organization owner privileges if true.

• squash_merge_commit_titlestringenum

  Default title for squash merge commits: 'PR_TITLE' or 'COMMIT_OR_PR_TITLE'.

  PR_TITLECOMMIT_OR_PR_TITLE
• squash_merge_commit_messagestringenum

  Default message for squash merge commits: 'PR_BODY', 'COMMIT_MESSAGES', or 'BLANK'.

  PR_BODYCOMMIT_MESSAGESBLANK
• use_squash_pr_title_as_defaultboolean

  DEPRECATED: Use `squash_merge_commit_title`. Default to pull request title for squash-merge commits.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full representation of the newly created repository.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the GitHub organization. This name is not case-sensitive.

• namestringObligatorio

  The name of the organization variable. Must be unique at the organization level.

• valuestringObligatorio

  The value of the organization variable.

• visibilitystringObligatorioenum

  Controls which repositories in the organization can access the variable. Accepted values are 'all' (all repositories), 'private' (only private repositories), or 'selected' (specific repositories designated by `selected_repository_ids`).

  allprivateselected
• selected_repository_idsinteger[]

  A list of repository integer IDs that can access this organization variable. This field is required and only applicable when `visibility` is set to 'selected'.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary indicating the successful creation of the organization variable, as the GitHub API typically returns an empty body (201 Created) for this operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the GitHub organization. This name is not case-sensitive.

• namestringObligatorio

  The name of the webhook. Must be "web" for organization webhooks.

• activeboolean

  Boolean indicating if the webhook is active. `true` sends notifications, `false` does not. Defaults to `true`.

• eventsstring[]

  List of event names to trigger the webhook. Use `['*']` for all events. Defaults to `['push']` if not specified. See GitHub docs for event types.

• config__urlstringuri

  The target URL for webhook payload delivery. This URL is a mandatory part of the webhook's `config` object and will receive POST requests for subscribed events.

• config__secretstring

  Optional secret for generating an HMAC hex digest for payload verification (X-Hub-Signature-256 header). If provided, this is used as the key.

• config__passwordstring

  Password for basic authentication if the webhook endpoint (`config_url`) requires it, corresponding to `config_username`.

• config__usernamestring

  Username for basic authentication if the webhook endpoint (`config_url`) requires it. Use only if your endpoint is protected by basic auth.

• config__content__typestring

  The media type for serializing webhook payloads. Supported: `json`, `form`. GitHub API defaults to `form` if this field is not set or is `None`.

• config__insecure__sslstring

  Controls SSL certificate verification for `config_url`. '1' disables verification (not recommended), '0' enables. GitHub API defaults to '0' (verification enabled) if this field is not set or is `None`.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the complete JSON representation of the created webhook object as returned by the GitHub API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• column_idintegerObligatorio

  The unique identifier of the project column where the card will be created. This value is used as a path parameter in the API request URL (e.g., `/projects/columns/{column_id}/cards`).

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full representation of the newly created project card, as returned by the GitHub API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name for the new project column.

• project_idintegerObligatorio

  The unique identifier of the target GitHub project (classic) where the new column will be created.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the attributes of the newly created project column. Key attributes typically include `id`, `node_id`, `name`, `url`, `project_url`, `cards_url`, `created_at`, and `updated_at`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• basestringObligatorio

  The name of the branch you want the changes pulled into. This must be an existing branch on the current (target) repository. You cannot submit a pull request to one repository that requests a merge to a base branch of another repository.

• bodystring

  The detailed description or contents of the pull request.

• headstringObligatorio

  The name of the branch where your changes are implemented. For cross-repository pull requests, namespace `head` with the source owner and branch, like `username:branch`.

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case-sensitive.

• draftboolean

  Indicates whether the pull request should be created as a draft. Draft pull requests cannot be merged until marked as ready for review.

• issueinteger

  The number of an existing issue in the repository to convert into a pull request. If provided, the issue's title and body may be used for the pull request. Required if `title` is not specified.

• ownerstringObligatorio

  The account owner of the repository. This name is not case-sensitive.

• titlestring

  The title of the new pull request. Required unless `issue` is specified.

• head_repostringrepo.nwo

  The name of the repository (e.g., 'octocat/Hello-World') where the changes in the pull request were made. This field is required for cross-repository pull requests if both the source and target repositories are owned by the same organization but are different repositories.

• maintainer_can_modifyboolean

  Indicates whether maintainers of the upstream repository can modify the pull request. This is primarily relevant for pull requests originating from forks.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full representation of the created pull request.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• refstringObligatorio

  Fully qualified reference to create (e.g., `refs/heads/master`, `refs/tags/v1.0.0`). Must start with `refs/` and contain at least two slashes.

• shastringObligatorio

  SHA-1 hash of an existing commit in the repository that the new reference will point to.

• repostringObligatorio

  The name of the repository without the `.git` extension. The name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. The name is not case sensitive.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created Git reference, typically including its `ref`, `node_id`, `url`, and target object (`sha`, `type`).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The name of the organization. This name is not case-sensitive.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the generated registration token and its expiration details, used for configuring self-hosted runners.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case-sensitive.

• ownerstringObligatorio

  The username of the account or the organization name that owns the repository. This field is not case-sensitive.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the registration token and its expiration details, such as the `token` string and `expires_at` timestamp.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystring

  A detailed description of the release. Markdown formatting is supported.

• namestring

  The title of the release. If omitted and `generate_release_notes` is false, it defaults to the `tag_name`.

• repostringObligatorio

  The name of the repository, without the .git extension. This field is not case-sensitive.

• draftboolean

  Set to `true` to create an unpublished (draft) release. Defaults to `false`.

• ownerstringObligatorio

  The account owner of the repository (username or organization name). This field is not case-sensitive.

• tag_namestringObligatorio

  The name of the tag for this release. This tag must be unique for published releases.

• prereleaseboolean

  Set to `true` to identify this release as a pre-release. Defaults to `false`.

• make_lateststring

  Specifies if this release should be marked as the latest for the repository. Valid values: 'true', 'false', 'legacy'. Defaults to 'true'. Draft releases and prereleases cannot be set as 'latest'.

• target_commitishstring

  Specifies the commitish value (e.g., branch name, tag name, or commit SHA) from which the Git tag is created. Defaults to the repository's default branch if the tag specified in `tag_name` doesn't exist yet.

• generate_release_notesboolean

  Set to `true` to automatically generate the release title (`name`) and description (`body`) from the commit history since the last release. Defaults to `false`.

• discussion_category_namestring

  If specified, a new discussion will be created in this category and linked to the release. The category must already exist in the repository's discussions.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  The unique identifier or name of the GitHub organization. This name is not case-sensitive. For example, if your organization's URL is github.com/my-org, 'my-org' is the value.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the generated time-limited token and its expiration details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Name of the repository, without the `.git` extension (not case-sensitive).

• ownerstringObligatorio

  Username of the account owning the repository (not case-sensitive).

Parámetros de salida

• dataobjectObligatorio

  Contains the generated remove token (e.g., `{'token': 'YOUR_GENERATED_TOKEN'}`), used to unregister a self-hosted runner.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystringObligatorio

  The text of the reply to the review comment.

• repostringObligatorio

  The name of the repository without the `.git` extension. The name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. The name is not case sensitive.

• comment_idintegerObligatorio

  The unique identifier of the comment to which the reply is being made.

• pull_numberintegerObligatorio

  The number that identifies the pull request.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the newly created reply to the review comment. The structure of this dictionary conforms to the GitHub API's representation of a pull request review comment.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository, without the `.git` extension (not case-sensitive).

• ownerstringObligatorio

  The account owner of the repository (not case-sensitive).

• event_typestringObligatorio

  Custom webhook event name (100 characters or fewer).

• client_payloadobject

  JSON payload with extra information for the webhook event (max 10 top-level properties), passed to the triggered workflow or action.

Parámetros de salida

• dataobject

  Empty dictionary on success (HTTP 204 No Content), or contains error details on failure.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the repository.

• privateboolean

  Whether the repository is private (true) or public (false).

• team_idinteger

  The ID of the team to be granted access. Only valid if creating in an organization.

• has_wikiboolean

  Whether the wiki is enabled.

• homepagestring

  A URL with more information about the repository.

• auto_initboolean

  Whether to initialize the repository with a README.

• has_issuesboolean

  Whether issues are enabled.

• descriptionstring

  A short description of the repository.

• is_templateboolean

  Whether this repository is a template repository.

• has_projectsboolean

  Whether projects are enabled.

• has_downloadsboolean

  Whether downloads are enabled (deprecated by GitHub and may not be configurable).

• has_discussionsboolean

  Whether discussions are enabled.

• allow_auto_mergeboolean

  Whether to allow auto-merge on pull requests.

• license_templatestring

  License template keyword (e.g., 'mit', 'apache-2.0').

• allow_merge_commitboolean

  Whether to allow merging pull requests with a merge commit.

• allow_rebase_mergeboolean

  Whether to allow rebase-merging pull requests.

• allow_squash_mergeboolean

  Whether to allow squash-merging pull requests.

• gitignore_templatestring

  Desired .gitignore template (e.g., 'Python', 'Node').

• merge_commit_titlestringenum

  The default title for a merge commit. `PR_TITLE` uses the pull request's title. `MERGE_MESSAGE` uses a classic title like 'Merge pull request #123 from branch-name'.

  PR_TITLEMERGE_MESSAGE
• merge_commit_messagestringenum

  The default message for a merge commit. `PR_BODY` uses the pull request's body. `PR_TITLE` uses the pull request's title. `BLANK` results in a blank commit message.

  PR_BODYPR_TITLEBLANK
• delete_branch_on_mergeboolean

  Whether to automatically delete head branches when pull requests are merged.

• squash_merge_commit_titlestringenum

  The default title for a squash merge commit. `PR_TITLE` uses the pull request's title. `COMMIT_OR_PR_TITLE` uses the commit's title (if only one commit) or the pull request's title (if multiple commits).

  PR_TITLECOMMIT_OR_PR_TITLE
• squash_merge_commit_messagestringenum

  The default message for a squash merge commit. `PR_BODY` uses the pull request's body. `COMMIT_MESSAGES` uses the branch's commit messages. `BLANK` results in a blank commit message.

  PR_BODYCOMMIT_MESSAGESBLANK

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The desired name for the new repository to be created from the codespace. If omitted, GitHub might generate a name (e.g., based on the codespace name).

• privateboolean

  Specifies the visibility of the new repository. Set to `true` for a private repository, or `false` for a public one. Defaults to `false` (public).

• codespace_namestringObligatorio

  The unique name of the codespace to be published as a new repository. This codespace must exist, be unpublished, and belong to the authenticated user.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystring

  An optional detailed description for the project board.

• namestringObligatorio

  The name of the project board to be created.

• repostringObligatorio

  The name of the repository without the `.git` extension. The name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. The name is not case sensitive.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full details of the newly created repository project board, as returned by the GitHub API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Unique name for the ruleset.

• repostringObligatorio

  Name of the repository, without the `.git` extension (not case-sensitive).

• ownerstringObligatorio

  Account owner of the repository (not case-sensitive).

• rulesobject[]

  Array of rule objects to be enforced. Each must have `type` and may have `parameters`. Refer to GitHub API docs for available rule types and parameters.

• targetstringenum

  The target of the ruleset, whether it applies to branches or tags.

  branchtag
• enforcementstringObligatorioenum

  Enforcement level: `disabled` (ruleset is not enforced), `active` (ruleset is enforced), or `evaluate` (test rules before enforcing; GitHub Enterprise only).

  disabledactiveevaluate
• bypass_actorsobject[]

  Actors that can bypass rules in this ruleset. Each actor object requires `actor_id`, `actor_type` (e.g., 'Team', 'Integration'), and `bypass_mode` (e.g., 'always').

• conditions__ref__name__excludestring[]

  Ref names or patterns to exclude. Condition fails if any pattern matches the ref name.

• conditions__ref__name__includestring[]

  Ref names/patterns to include. Condition passes if one pattern matches the ref name. Use `~DEFAULT_BRANCH` for default branch, `~ALL` for all branches.

Parámetros de salida

• dataobjectObligatorio

  Details of the created repository ruleset.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The desired name for the new repository to be created.

• ownerstring

  The username or organization name that will own the new repository. Defaults to the authenticated user if not provided.

• privateboolean

  Set to `true` to create a private repository, or `false` to create a public repository.

• descriptionstring

  A brief summary or description for the new repository.

• template_repostringObligatorio

  The name of the template repository, without the `.git` extension. This field is not case-sensitive.

• template_ownerstringObligatorio

  The username or organization name that owns the template repository. This field is not case-sensitive.

• include_all_branchesboolean

  Set to `true` to copy the directory structure and files from all branches of the template repository, not just the default branch.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the variable to create. Variable names are case-sensitive and can only contain alphanumeric characters ([a-z], [A-Z], [0-9]) or underscores (_). They cannot start with the `GITHUB_` prefix, and spaces are not allowed.

• repostringObligatorio

  The name of the repository, without the `.git` extension. This field is not case sensitive.

• ownerstringObligatorio

  The username or organization name that owns the repository. This field is not case sensitive.

• valuestringObligatorio

  The value of the variable. This will be stored as a string.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary. The GitHub API returns a 201 Created status with no content in the body upon successful creation of the repository variable.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  Name of the webhook. Use `web`. This parameter currently only accepts `web` and defaults to `web` if not provided.

• repostringObligatorio

  The name of the repository without the `.git` extension. This name is not case sensitive.

• ownerstringObligatorio

  The account owner of the repository. This name is not case sensitive.

• activeboolean

  Determines if notifications are sent when the webhook is triggered. `true` sends notifications (active), `false` disables them (inactive).

• eventsstring[]

  List of events to trigger the webhook (e.g., `['push']`, `['issues']`). See GitHub documentation for 'webhook event payloads'.

• config__urlstringuri

  The URL to which webhook payloads will be delivered via POST for subscribed events.

• config__secretstring

  Optional secret string for HMAC hex digest in delivery signature headers, enhancing security. See GitHub's 'delivery signature headers' documentation for details.

• config__content__typestring

  Media type for serializing payloads: `json` or `form`. Defaults to `form` if not specified. `json` delivers JSON, `form` delivers URL-encoded data.

• config__insecure__sslstring

  Determines SSL certificate verification for the payload URL: "0" to verify SSL (recommended), or "1" to skip. Defaults to "0" (verify SSL) if not provided.

Parámetros de salida

• dataobjectObligatorio

  Full details of the newly created webhook, typically including ID, type, configuration, active status, and subscribed events.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystringObligatorio

  Text content of the review comment.

• lineinteger

  **Required unless `subject_type` is 'file'**. Line number in the diff for the comment; for multi-line, this is the last line of the range.

• pathstringObligatorio

  Relative path of the file for the comment.

• repostringObligatorio

  Repository name without the `.git` extension (not case sensitive).

• sidestringenum

  Side of the diff (`LEFT` or `RIGHT`) for the comment in a split diff view; for multi-line comments, refers to the last line of the range.

  LEFTRIGHT
• ownerstringObligatorio

  Account owner of the repository (not case sensitive).

• positioninteger

  **Deprecated: Use `line` instead.** Position in the diff hunk for the comment (not the file line number).

• commit_idstringObligatorio

  SHA of the commit for the comment. Using an outdated `commit_id` can misplace the comment if lines change.

• start_lineinteger

  **Required for multi-line comments unless `in_reply_to` is used.** First line in the diff for a multi-line comment.

• start_sidestringenum

  **Required for multi-line comments unless `in_reply_to` is used.** Starting side of the diff (`LEFT` or `RIGHT`) for a multi-line comment.

  LEFTRIGHTside
• in_reply_tointeger

  ID of an existing review comment to reply to. If provided, other location parameters (except `body`) are ignored.

• pull_numberintegerObligatorio

  Identifier of the pull request.

• subject_typestringenum

  Level of the comment target: `line` (specific line) or `file` (entire file). Defaults to `line` if not provided.

  linefile

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created pull request review comment.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystring

  Review's main body text; required if `event` is `REQUEST_CHANGES` or `COMMENT`.

• repostringObligatorio

  Repository name, without the `.git` extension (case-insensitive).

• eventstringenum

  Review action type (`APPROVE`, `REQUEST_CHANGES`, `COMMENT`); if omitted, review is `PENDING` and requires later submission.

  APPROVEREQUEST_CHANGESCOMMENT
• ownerstringObligatorio

  Username of the account owning the repository (case-insensitive).

• commentsobject[]

  Inline draft review comments. Each object requires `path` (relative file path) and `body` (comment text). Optionally, specify `line` (or `start_line` for multi-line), and `side` (or `start_side`) for diff location. `position` is deprecated; use `line`. Example: `[{'path': 'file.py', 'line': 10, 'body': 'Refactor this.'}]`

• commit_idstring

  SHA of the commit to review; defaults to the latest pull request commit. Outdated SHAs may lead to stale comments.

• pull_numberintegerObligatorio

  Identifying number of the pull request.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• targetstring

  Username or organization name for scoping the new token. Required if `target_id` is not provided.

• client_idstringObligatorio

  Client ID of the GitHub App.

• target_idinteger

  ID of the user or organization for scoping the new token. Required if `target` is not provided.

• access_tokenstringObligatorio

  User-to-server access token to be exchanged for a new scoped token.

• repositoriesstring[]

  Repository names to scope the new token to. Cannot be used if `repository_ids` is specified.

• repository_idsinteger[]

  Repository IDs to scope the new token to. Cannot be used if `repositories` is specified.

• permissions__pagesstringenum

  Permission for GitHub Pages settings, statuses, configurations, builds, and creating new builds. Applies to target repositories.

  readwrite
• permissions__checksstringenum

  Permission for checks on code (e.g., CI statuses). Applies to target repositories.

  readwrite
• permissions__issuesstringenum

  Permission for issues, comments, assignees, labels, and milestones. Applies to target repositories.

  readwrite
• permissions__actionsstringenum

  Permission for GitHub Actions workflows, workflow runs, and artifacts. Applies to target repositories.

  readwrite
• permissions__membersstringenum

  Permission for organization members and teams. Applies to target organization.

  readwrite
• permissions__profilestringenum

  Permission to manage profile settings for the user account. Applies to target user.

  write
• permissions__secretsstringenum

  Permission for repository secrets (e.g., Actions secrets). Applies to target repositories.

  readwrite
• permissions__contentsstringenum

  Permission for repository contents, commits, branches, downloads, releases, and merges. Applies to target repositories.

  readwrite
• permissions__metadatastringenum

  Read-only permission for repository metadata, search, and collaborator listing. Applies to target repositories.

  readwrite
• permissions__packagesstringenum

  Permission for packages in GitHub Packages. Applies to target repositories or organization.

  readwrite
• permissions__starringstringenum

  Permission to list and manage repositories a user is starring. Applies to target user.

  readwrite
• permissions__statusesstringenum

  Permission for commit statuses. Applies to target repositories.

  readwrite
• permissions__followersstringenum

  Permission to manage followers for the user account. Applies to target user.

  readwrite
• permissions__gpg__keysstringenum

  Permission to view and manage GPG keys for the user account. Applies to target user.

  readwrite
• permissions__workflowsstringenum

  Permission for updating GitHub Actions workflow files. Requires `contents: write`. Applies to target repositories.

  write
• permissions__codespacesstringenum

  Permission for Codespaces. Applies to target user/organization if repositories are not specified, otherwise to target repositories.

  readwrite
• permissions__deploymentsstringenum

  Permission for deployments and deployment statuses. Applies to target repositories.

  readwrite
• permissions__environmentsstringenum

  Permission for repository environments. Applies to target repositories.

  readwrite
• permissions__single__filestringenum

  Permission to manage a single file. Requires `repository_ids` set to a single repository and `repositories` to a single file path.

  readwrite
• permissions__administrationstringenum

  Permission for repository administration (settings, teams, collaborators). Applies to target repositories.

  readwrite
• permissions__git__ssh__keysstringenum

  Permission to manage Git SSH keys for the user account. Applies to target user.

  readwrite
• permissions__pull__requestsstringenum

  Permission for pull requests, comments, assignees, labels, milestones, and merges. Applies to target repositories.

  readwrite
• permissions__email__addressesstringenum

  Permission to manage email addresses for the user account. Applies to target user.

  readwrite
• permissions__security__eventsstringenum

  Permission for security events (e.g., code scanning alerts). Applies to target repositories.

  readwrite
• permissions__repository__hooksstringenum

  Permission for repository webhooks. Applies to target repositories.

  readwrite
• permissions__team__discussionsstringenum

  Permission for team discussions and related comments. Applies to target organization.

  readwrite
• permissions__organization__planstringenum

  Read-only permission for viewing an organization's billing plan. Applies to target organization.

  read
• permissions__dependabot__secretsstringenum

  Permission for Dependabot secrets for targeted repositories.

  readwrite
• permissions__interaction__limitsstringenum

  Permission to view and manage interaction limits on a repository. Applies to target repositories or organization.

  readwrite
• permissions__organization__hooksstringenum

  Permission for organization webhooks. Applies to target organization.

  readwrite
• permissions__organization__eventsstringenum

  Read-only permission to view organization audit log events. Applies to target organization.

  read
• permissions__repository__projectsstringenum

  Permission for repository projects, columns, and cards. Applies to target repositories.

  readwriteadmin
• permissions__organization__secretsstringenum

  Permission for organization-level secrets (e.g., Actions secrets). Applies to target organization.

  readwrite
• permissions__vulnerability__alertsstringenum

  Permission for Dependabot alerts. Applies to target repositories.

  readwrite
• permissions__organization__packagesstringenum

  Permission for organization-level GitHub Packages. Applies to target organization.

  readwrite
• permissions__organization__projectsstringenum

  Permission for organization projects and projects beta (if available). Applies to target organization.

  readwriteadmin
• permissions__secret__scanning__alertsstringenum

  Permission for secret scanning alerts. Applies to target repositories.

  readwrite
• permissions__organization__custom__rolesstringenum

  Permission for custom repository roles within an organization. Applies to target organization.

  readwrite
• permissions__organization__administrationstringenum

  Permission for administrative settings of an organization. Applies to target organization.

  readwrite
• permissions__organization__user__blockingstringenum

  Permission for viewing and managing users blocked by the organization. Applies to target organization.

  readwrite
• permissions__repository__custom__propertiesstringenum

  Permission to view and edit repository custom properties, if allowed by property definition. Applies to target repositories.

  readwrite
• permissions__organization__custom__org__rolesstringenum

  Permission for custom organization roles. Applies to target organization.

  readwrite
• permissions__organization__custom__propertiesstringenum

  Permission for custom properties for an organization. Applies to target organization.

  readwriteadmin
• permissions__organization__announcement__bannersstringenum

  Permission to view and manage organization announcement banners. Applies to target organization.

  readwrite
• permissions__organization__self__hosted__runnersstringenum

  Permission for GitHub Actions self-hosted runners for an organization. Applies to target organization.

  readwrite
• permissions__organization__personal__access__tokensstringenum

  Permission for fine-grained personal access tokens requested by organization members. Applies to target organization.

  readwrite
• permissions__organization__copilot__seat__managementstringenum

  Permission for GitHub Copilot seat assignments for organization members (beta). Applies to target organization.

  write
• permissions__organization__personal__access__token__requestsstringenum

  Permission for requests for fine-grained personal access tokens within an organization. Applies to target organization.

  readwrite

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created scoped access token, including the token, `expires_at`, `permissions`, and repository scope.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• refstringObligatorio

  Git reference (fully qualified, e.g., `refs/heads/main`) of the repository branch/tag that triggered this snapshot.

• shastringObligatorio

  Commit SHA (maximum 40 characters) associated with this dependency snapshot.

• repostringObligatorio

  Repository name, without `.git` extension (name is not case-sensitive).

• ownerstringObligatorio

  Account owner of the repository (name is not case-sensitive).

• job__idstring

  Optional external ID of the job that generated this snapshot.

• scannedstringObligatoriodate-time

  UTC timestamp (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ) when the snapshot was taken.

• versionintegerObligatorio

  Version of the dependency snapshot submission, typically of the manifest or lock file format.

• metadataobject

  Optional user-defined metadata for domain-specific information. Limited to 8 keys with scalar values (e.g., string, number, boolean).

• manifestsobject

  Optional collection of package manifests (e.g., package-lock.json, pom.xml). Keys are manifest file names; values detail dependencies.

• detector__urlstring

  Optional URL of the detector tool used.

• detector__namestring

  Optional name of the tool used to detect dependencies.

• job__html__urlstring

  Optional URL for the job that generated this snapshot.

• job__correlatorstring

  Optional string to group snapshots. For a given `job.correlator` and `detector.name`, only the 'latest' snapshot is current. Useful to distinguish detection runs (e.g., concatenating GITHUB_WORKFLOW and GITHUB_JOB).

• detector__versionstring

  Optional version of the detector tool used.

Parámetros de salida

• dataobjectObligatorio

  ID of the created snapshot and a confirmation message.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tagstringObligatorio

  The name of the tag, typically a version identifier (e.g., "v0.0.1").

• repostringObligatorio

  The name of the repository, without the `.git` extension. This name is not case-sensitive.

• typestringObligatorioenum

  The type of the Git object being tagged.

  committreeblob
• ownerstringObligatorio

  The account owner of the repository. This name is not case-sensitive.

• objectstringObligatorio

  The SHA of the Git object (commit, tree, or blob) that this tag is pointing to.

• messagestringObligatorio

  The message associated with the tag.

• tagger__datestringdate-time

  The timestamp for when this object was tagged. This should be in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

• tagger__namestring

  The name of the person creating the tag.

• tagger__emailstring

  The email address of the person creating the tag.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository without the `.git` extension. Not case sensitive.

• ownerstringObligatorio

  The account owner of the repository (username or organization name). Not case sensitive.

• patternstringObligatorio

  Glob pattern to protect tags. Examples: `v1.*` (protects tags starting with `v1.`), `*` (protects all tags).

Parámetros de salida

• dataobjectObligatorio

  Empty dictionary, as a successful creation returns an empty body with a 201 status code.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgstringObligatorio

  Organization name where the team will be created (not case-sensitive).

• namestringObligatorio

  Name of the new team.

• privacystringenum

  Team privacy: 'secret' (visible to owners and members) or 'closed' (visible to all org members). Defaults to 'secret' for non-nested teams; must be 'closed' if `parent_team_id` is set.

  secretclosed
• permissionstringenum

  **Deprecated**. Default repository permission ('pull' for read access, 'push' for write access) for the team.

  pullpush
• repo_namesstring[]

  Repository full names (e.g., "org-name/repo-name") for team access; repositories must exist and be accessible to the organization.

• descriptionstring

  Team's purpose or focus.

• maintainersstring[]

  GitHub user handles of organization members to be team maintainers; users must be organization members.

• parent_team_idinteger

  ID of an existing team to be the parent, creating a nested team. If provided, new team `privacy` must be 'closed'.

• notification_settingstringenum

  Notification settings for @mentions: 'notifications_enabled' (members notified) or 'notifications_disabled' (no one notified). Default: 'notifications_enabled'.

  notifications_enablednotifications_disabled

Parámetros de salida

• dataobjectObligatorio

  Full representation of the newly created team from the GitHub API.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  Name of the repository, without the `.git` extension; not case-sensitive.

• ownerstringObligatorio

  Account owner (username or organization) of the repository; not case-sensitive.

• ghsa_idstringObligatorio

  Identifier for the GitHub Security Advisory (e.g., GHSA-rfv9-x7w6-39px) that the fork will address.

Parámetros de salida

• dataobjectObligatorio

  Full repository object of the newly created temporary private fork.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• repostringObligatorio

  The name of the repository without the `.git` extension. The name is not case sensitive.

• treeobject[]Obligatorio

  List of objects defining the tree structure. Each object (node) requires `path` (string), `mode` (string; e.g., '100644' file, '100755' executable, '040000' subdirectory/tree, '160000' submodule, '120000' symlink), and `type` (string: 'blob', 'tree', or 'commit'). For new/updated blobs, provide `content` (UTF-8 string). For existing objects or `tree`/`commit` types, provide `sha` (string). To delete, specify `path`, `mode`, `type`, and set `sha` to `null`.

• ownerstringObligatorio

  The account owner of the repository. The name is not case sensitive.

• base_treestring

  SHA1 of an existing Git tree object to use as a base. If provided, its entries are combined with `tree` entries, where `tree` entries overwrite those from `base_tree` with the same path. Typically the SHA1 of the latest commit's tree for new branch changes. If omitted, the new tree is built from `tree` entries; files from the parent commit's tree not in `tree` are treated as deleted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the created Git tree object. It includes the `sha` and `url` of the new tree, an array of `tree` items (nodes in the tree), and a `truncated` boolean flag indicating if the number of items in the tree array exceeded the maximum limit and was cut short.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bodystring

  Body or description for the new project.

• namestringObligatorio

  Name for the new project.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• refstringObligatorio

  Git reference (branch or tag) for the workflow.

• repostringObligatorio

  Repository name, excluding the `.git` extension (case-insensitive).

• ownerstringObligatorio

  Owner of the repository (username or organization, case-insensitive).

• inputsobject

  Key-value inputs for the workflow, matching `on.workflow_dispatch.inputs` definitions (max 10); uses workflow defaults if omitted.

• workflow_idintegerObligatorio

  Identifier of the workflow, which can be its numeric ID or filename (e.g., 'main.yml'); the GitHub API accepts either format.