docker.com – hub

Tools (30)

Extracted live via the executor SDK.

• accessTokens.deleteV2AccessTokensUuid

  Deletes a personal access token permanently. This cannot be undone.

• accessTokens.getV2AccessTokens

  Returns a paginated list of personal access tokens.

• accessTokens.getV2AccessTokensUuid

  Returns a personal access token by UUID.

• accessTokens.patchV2AccessTokensUuid

  Updates a personal access token partially. You can either update the token's label or enable/disable it.

• accessTokens.postV2AccessTokens

  Creates and returns a personal access token.

• auditLogs.auditLogsGetAuditActions

  Get audit log actions for a namespace to be used as a filter for querying audit events.

• auditLogs.auditLogsGetAuditLogs

  Get audit log events for a given namespace.

• authentication.postUsers2FaLogin

  When user has 2FA enabled, this is the second call to perform after /v2/users/login call.

  Creates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.

  The returned token is used in the HTTP Authorization header like Authorization: Bearer {TOKEN}.

  Most Docker Hub APIs require this token either to consume or to get detailed information. For example, to list images in a private repository.

• authentication.postUsersLogin

  Creates and returns a bearer token in JWT format that you can use to authenticate with Docker Hub APIs.

  The returned token is used in the HTTP Authorization header like Authorization: Bearer {TOKEN}.

  Most Docker Hub APIs require this token either to consume or to get detailed information. For example, to list images in a private repository.

• images.getNamespacesRepositoriesImages

  Gets details on the images in a repository.

• images.getNamespacesRepositoriesImagesSummary

  Gets the number of images in a repository and the number of images counted as active and inactive.

• images.getNamespacesRepositoriesImagesTags

  Gets current and historical tags for an image.

• images.postNamespacesDeleteImages

  Deletes one or more images within a namespace. This is currently limited to a single repository.

  If you attempt to delete images that are marked as active or are currently tagged, the deletion does not happen and it displays the warnings. To continue with the deletion, you must ignore these warnings by putting them in the ignore_warnings property.

  Deleting a currently tagged image deletes the tag from the repository.

  You cannot ignore errors. It is not possible to directly delete children of multi-arch images.

• orgSettings.getV2OrgsNameSettings

  Returns organization settings by name.

• orgSettings.putV2OrgsNameSettings

  Updates an organization's settings. Some settings are only used when the organization is on a business plan.

  Only users in the "owners" group of the organization can use this endpoint.

  The following settings are only used on a business plan:

  • restricted_images
• repositories.getV2NamespacesNamespaceRepositoriesRepositoryTags

  List repository tags

• repositories.getV2NamespacesNamespaceRepositoriesRepositoryTagsTag

  Read repository tag

• repositories.headV2NamespacesNamespaceRepositoriesRepositoryTags

  Check repository tags

• repositories.headV2NamespacesNamespaceRepositoriesRepositoryTagsTag

  Check repository tag

• scim.getV2Scim20ResourceTypes

  Returns all resource types supported for the SCIM configuration.

• scim.getV2Scim20ResourceTypesName

  Returns a resource type by name.

• scim.getV2Scim20Schemas

  Returns all schemas supported for the SCIM configuration.

• scim.getV2Scim20SchemasId

  Returns a schema by ID.

• scim.getV2Scim20ServiceProviderConfig

  Returns a service provider config for Docker's configuration.

• scim.getV2Scim20Users

  List users, returns paginated users for an organization. Use startIndex and count query parameters to receive paginated results.

  Sorting:
  Sorting lets you to specify the order of returned resources by specifying a combination of sortBy and sortOrder query parameters.

  The sortBy parameter specifies the attribute whose value will be used to order the returned responses. The sortOrder parameter defines the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending".

  Filtering:
  You can request a subset of resources by specifying the filter query parameter containing a filter expression. Attribute names and attribute operators used in filters are case insensitive. The filter parameter must contain at least one valid expression. Each expression must contain an attribute name followed by an attribute operator and an optional value.

  Supported operators are listed below.

  • eq equal
  • ne not equal
  • co contains
  • sw starts with
  • and Logical "and"
  • or Logical "or"
  • not "Not" function
  • () Precedence grouping
• scim.getV2Scim20UsersId

  Returns a user by ID.

• scim.postV2Scim20Users

  Creates a user. If the user already exists by email, they are assigned to the organization on the "company" team.

• scim.putV2Scim20UsersId

  Updates a user. Use this route to change the user's name, activate, and deactivate the user.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools