Portainer · Schema

registries.registryCreatePayload

Container ManagementContainersDockerKubernetesKubernetes ManagementEnterprise IdentityGitOps

Properties

Name	Type	Description
Authentication	boolean	Is authentication against this registry enabled
BaseURL	string	BaseURL required for ProGet registry
Ecr	object	ECR specific details, required when type = 7
Gitlab	object	Gitlab specific details, required when type = 4
Name	string	Name that will be used to identify this registry
Password	string	Password used to authenticate against this registry. required when Authentication is true
Quay	object	Quay specific details, required when type = 1
TLS	boolean	Use TLS
Type	object	Registry Type. Valid values are: 1 (Quay.io), 2 (Azure container registry), 3 (custom registry), 4 (Gitlab registry), 5 (ProGet registry), 6 (DockerHub) 7 (ECR)
URL	string	URL or IP address of the Docker registry
Username	string	Username used to authenticate against this registry. Required when Authentication is true

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/portainer/main/json-schema/portainer-registries-registry-create-payload-schema.json",
  "title": "registries.registryCreatePayload",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/portainer-registries-api-openapi.yml#/components/schemas/registries.registryCreatePayload",
  "properties": {
    "Authentication": {
      "description": "Is authentication against this registry enabled",
      "type": "boolean"
    },
    "BaseURL": {
      "description": "BaseURL required for ProGet registry",
      "type": "string"
    },
    "Ecr": {
      "allOf": [
        {
          "$ref": "#/$defs/portainer.EcrData"
        }
      ],
      "description": "ECR specific details, required when type = 7"
    },
    "Gitlab": {
      "allOf": [
        {
          "$ref": "#/$defs/portainer.GitlabRegistryData"
        }
      ],
      "description": "Gitlab specific details, required when type = 4"
    },
    "Name": {
      "description": "Name that will be used to identify this registry",
      "type": "string"
    },
    "Password": {
      "description": "Password used to authenticate against this registry. required when Authentication is true",
      "type": "string"
    },
    "Quay": {
      "allOf": [
        {
          "$ref": "#/$defs/portainer.QuayRegistryData"
        }
      ],
      "description": "Quay specific details, required when type = 1"
    },
    "TLS": {
      "description": "Use TLS",
      "type": "boolean"
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/$defs/portainer.RegistryType"
        }
      ],
      "description": "Registry Type. Valid values are:\n\t1 (Quay.io),\n\t2 (Azure container registry),\n\t3 (custom registry),\n\t4 (Gitlab registry),\n\t5 (ProGet registry),\n\t6 (DockerHub)\n\t7 (ECR)",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7
      ]
    },
    "URL": {
      "description": "URL or IP address of the Docker registry",
      "type": "string"
    },
    "Username": {
      "description": "Username used to authenticate against this registry. Required when Authentication is true",
      "type": "string"
    }
  },
  "required": [
    "Authentication",
    "Name",
    "Type",
    "URL"
  ],
  "type": "object",
  "$defs": {
    "portainer.EcrData": {
      "properties": {
        "Region": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "portainer.GitlabRegistryData": {
      "properties": {
        "InstanceURL": {
          "type": "string"
        },
        "ProjectId": {
          "type": "integer"
        },
        "ProjectPath": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "portainer.QuayRegistryData": {
      "properties": {
        "OrganisationName": {
          "type": "string"
        },
        "UseOrganisation": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "portainer.RegistryType": {
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8
      ],
      "type": "integer",
      "x-enum-varnames": [
        "_",
        "QuayRegistry",
        "AzureRegistry",
        "CustomRegistry",
        "GitlabRegistry",
        "ProGetRegistry",
        "DockerHubRegistry",
        "EcrRegistry",
        "GithubRegistry"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/portainer-registries-registry-create-payload"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.