> ## Documentation Index > Fetch the complete documentation index at: https://docs.app.strix.ai/llms.txt > Use this file to discover all available pages before exploring further. # Connect a container registry > Connect a registry and verify the credential. Strix encrypts the credential and never returns it. Session callers must hold the admin or analyst role without asset scopes. Container scanning requires the Enterprise plan. ## OpenAPI ````yaml /openapi.json post /containers/registries openapi: 3.1.0 info: title: Strix API version: 1.0.0 description: >- Public REST API for the Strix autonomous penetration testing platform. Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks. servers: - url: /api/v1 description: Strix v1 API security: - BearerAuth: [] tags: - name: Scans description: Launch, monitor, and manage security scans. - name: Vulnerabilities description: View and triage discovered vulnerabilities. - name: Assets description: Domains and repositories registered for scanning. - name: Schedules description: Recurring scan schedules (Pro plan). - name: Search description: Search across issues, pentests, PR reviews, chats, assets and schedules. - name: Tokens description: Manage API tokens for authentication. - name: Webhooks description: Configure webhook subscriptions for real-time event notifications. - name: Organization description: Workspace configuration for the authenticated organization. - name: Members description: Manage organization members and roles. - name: Invitations description: List and revoke organization invitations. - name: PR Reviews description: Automated security review of pull requests. - name: Connectors description: Network connectors for scanning internal/private targets. - name: Knowledge description: >- Organization knowledge base: documents, policies, and repo profiles that steer the agent. - name: Uploads description: Upload source/code/documentation archives for whitebox scans. - name: Integrations description: Third-party integrations (GitLab, Bitbucket, ticketing). - name: Chat description: Conversational agent sessions. - name: Analytics description: Aggregate dashboard analytics. - name: Test Users description: >- Per-domain test accounts (with optional MFA) the agent authenticates as during scans. - name: License description: Self-hosted license state, entitlements, and aggregate usage. - name: Supply Chain description: >- SBOM inventory, supply-chain findings, scans, and policy for connected repositories. - name: CLI description: >- Device authorization endpoints that let the Strix CLI and coding agents sign in and receive an API token. - name: Billing description: Credit balance, agent-payable top-ups, and automatic top-up settings. - name: Workspaces description: List, create, and switch workspaces. - name: Asset Discovery description: >- Passive reconnaissance runs that map the organization's external attack surface, and the discovered-asset inventory they fill. - name: Containers description: >- Container registries, tracked images, image scans, findings, and SBOM components. - name: Run Logs description: Persisted engine logs and the diagnostics bundle of a self-hosted install. paths: /containers/registries: post: tags: - Containers summary: Connect a container registry description: >- Connect a registry and verify the credential. Strix encrypts the credential and never returns it. Session callers must hold the admin or analyst role without asset scopes. Container scanning requires the Enterprise plan. operationId: createContainerRegistry requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateContainerRegistryRequest' responses: '201': description: The connected registry. content: application/json: schema: type: object properties: registry: $ref: '#/components/schemas/ContainerRegistry' required: - registry '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' security: - BearerAuth: - containers:write components: schemas: CreateContainerRegistryRequest: type: object properties: provider: $ref: '#/components/schemas/ContainerRegistryProvider' description: Registry provider. See `ContainerRegistryProvider`. registry_host: type: - string - 'null' description: >- Registry host. Required for `generic` (for example `registry.example.com`), `gar` (a regional host such as `us-central1-docker.pkg.dev`), `ecr` (`123456789012.dkr.ecr.us-east-1.amazonaws.com`) and `acr` (`myregistry.azurecr.io`). Ignored for `ghcr` and `dockerhub`, whose hosts are fixed. label: type: - string - 'null' description: Display name for the connection. Defaults to the registry host. auth_kind: $ref: '#/components/schemas/ContainerRegistryAuthKind' description: >- How Strix authenticates. Use `none` for public images on `generic` or `dockerhub`. Use `basic_token` for a username and token. `ghcr`, `gar` and `acr` require it. Use `aws_assume_role` for `ecr`. This kind stores no credential. Strix assumes the IAM role in `aws_role_arn` on every pull. username: type: - string - 'null' description: >- Username for `basic_token`. Required for `ghcr` (GitHub username), `dockerhub` when a token is given, and `acr` (service principal application id). Ignored for `gar`, which always signs in as `_json_key`. secret: type: - string - 'null' description: >- Token or password for `basic_token`. For `gar`, the service account key file (JSON) of an account with the Artifact Registry Reader role. Strix encrypts the value and never returns it. aws_role_arn: type: - string - 'null' description: >- IAM role ARN for `aws_assume_role`. Must be in the account that owns the registry. Get the trust policy inputs from `GET /containers/registries/ecr-setup`. required: - provider - auth_kind ContainerRegistry: type: object properties: id: type: string format: uuid provider: $ref: '#/components/schemas/ContainerRegistryProvider' label: type: string description: Display label, for example `ghcr.io/acme`. registry_url: type: string description: Registry host, for example `ghcr.io`. auth_kind: $ref: '#/components/schemas/ContainerRegistryAuthKind' aws_role_arn: type: - string - 'null' description: >- IAM role Strix assumes for `aws_assume_role` registries. Null for every other auth kind. status: $ref: '#/components/schemas/ContainerRegistryStatus' image_count: type: integer description: Number of images that Strix tracks in this registry. last_verified_at: type: - string - 'null' format: date-time verification_error: type: - string - 'null' description: >- Reason the last verification failed. Null when the registry is connected. required: - id - provider - label - registry_url - auth_kind - aws_role_arn - status - image_count - last_verified_at - verification_error description: >- A connected container registry. The response never contains the stored credential. ContainerRegistryProvider: type: string description: >- `dockerhub` Docker Hub, `ghcr` GitHub Container Registry, `gar` Google Artifact Registry (and Container Registry), `ecr` Amazon ECR, `acr` Azure Container Registry, `generic` any other OCI Distribution registry. enum: - ghcr - dockerhub - ecr - gar - acr - generic ContainerRegistryAuthKind: type: string enum: - basic_token - aws_assume_role - none ContainerRegistryStatus: type: string enum: - connected - disconnected - verifying ErrorResponse: type: object properties: detail: type: string description: Human-readable explanation of the error. code: type: string description: >- Stable machine-readable error code. `insufficient_scope` means the token does not hold the scope that this endpoint requires. required_scope: $ref: '#/components/schemas/ApiV1Scope' description: >- Scope that the caller must add to the token. Returned with the `insufficient_scope` code. docs: type: string format: uri description: Documentation page that explains how to resolve the error. hint: type: string description: >- One instruction that resolves the error. For `insufficient_scope`, a CLI session gets the `strix cloud session scopes set full` or `strix cloud login --scope-profile full` command, and an API token gets the settings page where the user creates a token with the scope. When the owner's role cannot hold the scope, the hint asks for a role change instead. required: - detail ApiV1Scope: type: string enum: - scans:read - scans:write - vulnerabilities:read - vulnerabilities:write - dependencies:read - schedules:read - schedules:write - assets:read - assets:write - organizations:read - organizations:write - members:read - members:write - invitations:read - invitations:write - webhooks:read - webhooks:write - tokens:write - audit:read - pr_reviews:read - pr_reviews:write - connectors:read - connectors:write - knowledge:read - knowledge:write - uploads:write - integrations:read - integrations:write - chat:read - chat:write - scans:message - analytics:read - llm:read - llm:write - test_users:read - test_users:write - discovery:read - discovery:write - license:read - supply_chain:read - supply_chain:write - billing:read - billing:write - containers:read - containers:write - logs:read responses: BadRequest: description: Bad request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Missing or invalid API token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Insufficient permissions or missing scope. A missing scope returns the `insufficient_scope` code, the `required_scope` field, and a `hint` with the command or page that grants the scope, so a client can request the correct scope and retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer description: >- API token obtained from the Tokens endpoint or CLI device login. Include as `Authorization: Bearer `. Requests made with a managed CLI session also include `X-Strix-Workspace: ` to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.