---
updatedAt: 2026-04-21T08:54:41.000Z
agentTools:
  projectIndex: https://docs.scalr.io/llms.txt
---

# Update a Docker integration

Update a Docker integration.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "DockerIntegration": {
        "properties": {
          "attributes": {
            "properties": {
              "error-message": {
                "description": "Last Docker registry connection test error message, if any.",
                "nullable": true,
                "readOnly": true,
                "type": "string"
              },
              "export-credentials": {
                "default": false,
                "description": "Whether registry credentials should be exported into the run pipeline for OpenTofu OCI module access.",
                "type": "boolean"
              },
              "name": {
                "description": "Name of the Docker integration.",
                "maxLength": 128,
                "type": "string"
              },
              "password": {
                "description": "Docker registry password or personal access token used for authentication.",
                "nullable": true,
                "type": "string"
              },
              "registry-url": {
                "description": "Docker registry URL. Use the registry endpoint used by the runtime. Its normalized host[:port] is used as the auth server address.",
                "maxLength": 512,
                "type": "string"
              },
              "status": {
                "description": "Integration status after the latest connection test.",
                "enum": [
                  "active",
                  "disabled",
                  "failed",
                  "pending"
                ],
                "type": "string"
              },
              "username": {
                "description": "Docker registry username used for authentication.",
                "maxLength": 255,
                "nullable": true,
                "type": "string"
              }
            },
            "required": [
              "name",
              "registry-url",
              "username"
            ],
            "type": "object"
          },
          "id": {
            "readOnly": true,
            "type": "string"
          },
          "links": {
            "properties": {
              "self": {
                "readOnly": true,
                "type": "string"
              }
            },
            "readOnly": true,
            "type": "object"
          },
          "relationships": {
            "properties": {
              "account": {
                "description": "The account this integration belongs to.",
                "properties": {
                  "data": {
                    "nullable": true,
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "type": {
                        "enum": [
                          "accounts",
                          ""
                        ],
                        "type": "string"
                      }
                    },
                    "required": [
                      "type",
                      "id"
                    ],
                    "type": "object"
                  }
                },
                "readOnly": true,
                "required": [
                  "data"
                ],
                "type": "object"
              }
            },
            "type": "object"
          },
          "type": {
            "enum": [
              "docker-integrations"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "attributes"
        ],
        "type": "object"
      },
      "DockerIntegrationDocument": {
        "description": "JSON:API Document.\n\nsee: https://jsonapi.org/format/#document-structure",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/DockerIntegration"
          },
          "included": {
            "items": {
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "meta": {
            "readOnly": true,
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "API-Key": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Scalr IACP API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "title": "Scalr IACP API",
    "version": "unversioned"
  },
  "openapi": "3.0.0",
  "paths": {
    "/integrations/docker/{docker_integration}": {
      "patch": {
        "description": "Update a Docker integration.",
        "operationId": "update_docker_integration",
        "parameters": [
          {
            "in": "path",
            "name": "docker_integration",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/vnd.api+json": {
              "schema": {
                "$ref": "#/components/schemas/DockerIntegrationDocument"
              }
            }
          }
        },
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/DockerIntegrationDocument"
                }
              }
            },
            "description": ""
          },
          "4XX": {
            "description": "Client error."
          },
          "5XX": {
            "description": "Server error."
          }
        },
        "summary": "Update a Docker integration",
        "tags": [
          "docker-integrations"
        ],
        "x-resource": "DockerIntegration",
        "x-service": "tf-api"
      }
    }
  },
  "security": [
    {
      "API-Key": []
    }
  ],
  "servers": [
    {
      "url": "https://{Domain}/api/iacp/v3",
      "variables": {
        "Domain": {
          "default": "example.scalr.io",
          "description": "Domain where Scalr is hosted"
        }
      }
    }
  ]
}
```

# Sibling pages

* [List Docker integrations](https://docs.scalr.io/scalr/reference/list_docker_integrations.md)
* [Create a Docker integration](https://docs.scalr.io/scalr/reference/create_docker_integration.md)
* [Delete a Docker integration](https://docs.scalr.io/scalr/reference/delete_docker_integration.md)
* [Get a Docker integration](https://docs.scalr.io/scalr/reference/get_docker_integration.md)