Search or ask Docker

IndexInfo

IndexInfo schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

IndexInfo contains information about a registry.
Mirrors

Type: array

List of mirrors, expressed as URIs.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of mirrors, expressed as URIs.\n",
  "example": [
    "https://hub-mirror.corp.example.com:5000/",
    "https://registry-2.docker.io/",
    "https://registry-3.docker.io/"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Name

Type: string

Name of the registry, such as "docker.io".
All schema constraints and annotations
{
  "description": "Name of the registry, such as \"docker.io\".\n",
  "example": "docker.io",
  "type": "string"
}
Official

Type: boolean

Indicates whether this is an official registry (i.e., Docker Hub / docker.io)
All schema constraints and annotations
{
  "description": "Indicates whether this is an official registry (i.e., Docker Hub / docker.io)\n",
  "example": true,
  "type": "boolean"
}
Secure

Type: boolean

Indicates if the registry is part of the list of insecure registries.

If false, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication.

Warning: Insecure registries can be useful when running a local registry. However, because its use creates security vulnerabilities it should ONLY be enabled for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.

All schema constraints and annotations
{
  "description": "Indicates if the registry is part of the list of insecure\nregistries.\n\nIf `false`, the registry is insecure. Insecure registries accept\nun-encrypted (HTTP) and/or untrusted (HTTPS with certificates from\nunknown CAs) communication.\n\n\u003e **Warning**: Insecure registries can be useful when running a local\n\u003e registry. However, because its use creates security vulnerabilities\n\u003e it should ONLY be enabled for testing purposes. For increased\n\u003e security, users should add their CA to their system's list of\n\u003e trusted CAs instead of enabling this option.\n",
  "example": true,
  "type": "boolean"
}
All schema constraints and annotations
{
  "description": "IndexInfo contains information about a registry.",
  "properties": {
    "Mirrors": {
      "description": "List of mirrors, expressed as URIs.\n",
      "example": [
        "https://hub-mirror.corp.example.com:5000/",
        "https://registry-2.docker.io/",
        "https://registry-3.docker.io/"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Name": {
      "description": "Name of the registry, such as \"docker.io\".\n",
      "example": "docker.io",
      "type": "string"
    },
    "Official": {
      "description": "Indicates whether this is an official registry (i.e., Docker Hub / docker.io)\n",
      "example": true,
      "type": "boolean"
    },
    "Secure": {
      "description": "Indicates if the registry is part of the list of insecure\nregistries.\n\nIf `false`, the registry is insecure. Insecure registries accept\nun-encrypted (HTTP) and/or untrusted (HTTPS with certificates from\nunknown CAs) communication.\n\n\u003e **Warning**: Insecure registries can be useful when running a local\n\u003e registry. However, because its use creates security vulnerabilities\n\u003e it should ONLY be enabled for testing purposes. For increased\n\u003e security, users should add their CA to their system's list of\n\u003e trusted CAs instead of enabling this option.\n",
      "example": true,
      "type": "boolean"
    }
  },
  "type": "object",
  "x-nullable": true
}