Container Registry

A container registry holds the credentials used to pull private images. Its ID is what a service passes as containerRegistryId when creating a stack.

All requests go to the Run-App gateway and need the authentication headers.

Registry List

Query · container_listContainerRegistry

Returns a paginated list of container registries.

Arguments

NameTypeRequiredDescription
pagercontainer_PagerInputNoPagination options

pager

FieldTypeRequiredDescription
pageNumberYesThe number of current page
limitNumberYesThe number of limit data

Variables

{
  "subscriptionId": "67ab067f092e8f8c2beb2df5",
  "pager": {
    "page": 1,
    "limit": 100
  }
}

Request

query listContainerRegistry($pager: container_PagerInput) {
  container_listContainerRegistry(pager: $pager) {
    containerRegistries {
      createdAt
      host
      id
      mysabayUserId
      name
      updatedAt
      userAccess
    }
    pagination {
      currentPage
      from
      lastPage
      perPage
      to
      total
    }
  }
}

Response

{
  "data": {
    "container_listContainerRegistry": {
      "containerRegistries": [
        {
          "createdAt": 1725417988748,
          "host": "example-registry-edit.com",
          "id": "66d7ca042d67cb0ada9d8408",
          "mysabayUserId": 39555695,
          "name": "custom",
          "updatedAt": 1725421468701,
          "userAccess": {
            "username": "registry name edit"
          }
        },
        {
          "createdAt": 1730883024046,
          "host": "example-registry.com",
          "id": "672b2dd0a706d0ef04a59c3d",
          "mysabayUserId": 39555695,
          "name": "docker_hub",
          "updatedAt": 0,
          "userAccess": {
            "username": "test"
          }
        }
      ],
      "pagination": {
        "currentPage": 1,
        "from": 1,
        "lastPage": 1,
        "perPage": 50,
        "to": 2,
        "total": 2
      }
    }
  }
}

Registry Information

Query · container_getContainerRegistryById

Returns a single container registry.

Arguments

NameTypeRequiredDescription
containerRegistryIdStringYesThe ID of the registry

Variables

{
  "subscriptionId": "67ab067f092e8f8c2beb2df5",
  "containerRegistryId": "66d7ca042d67cb0ada9d8408"
}

Request

query Container_getContainerRegistryById($containerRegistryId: String!) {
  container_getContainerRegistryById(
    containerRegistryId: $containerRegistryId
  ) {
    id
    mysabayUserId
    name
    host
    userAccess
    createdAt
    updatedAt
  }
}

Response

{
  "data": {
    "container_getContainerRegistryById": {
      "id": "66d7ca042d67cb0ada9d8408",
      "mysabayUserId": 39555695,
      "name": "custom",
      "host": "example-registry-edit.com",
      "userAccess": {
        "username": "registry name edit"
      },
      "createdAt": 1725417988748,
      "updatedAt": 1725421468701
    }
  }
}

Registry Providers

Query · container_listContainerRegistryProvider

Returns the supported container registry providers. Takes no arguments.

Request

query listRegistryProvider {
  container_listContainerRegistryProvider {
    containerRegistryProviders
  }
}

Response

{
  "data": {
    "container_listContainerRegistryProvider": {
      "containerRegistryProviders": {
        "custom": "Custom",
        "docker_hub": "Docker Hub",
        "gitlab": "Gitlab"
      }
    }
  }
}

Create Registry

Mutation · container_createContainerRegistry

Creates a container registry.

Arguments

NameTypeRequiredDescription
inputcontainer_CreateContainerRegistryInputYesRegistry configuration

input

FieldTypeRequiredDescription
nameStringYesThe name of registry
hostStringYesThe host of registry
usernameStringYesThe username of registry
accessTokenStringYesThe accessToken of registry

Variables

{
  "input": {
    "username": "admin",
    "name": "custom",
    "host": "test.com",
    "accessToken": "12345"
  }
}

Request

mutation createRegistry($input: container_CreateContainerRegistryInput!) {
  container_createContainerRegistry(input: $input) {
    id
    mysabayUserId
    name
    host
    userAccess
    createdAt
    updatedAt
  }
}

Response

{
  "data": {
    "container_createContainerRegistry": {
      "id": "674ebff6c12192a423b48b2d",
      "mysabayUserId": 39555695,
      "name": "custom",
      "host": "nasfong.com",
      "userAccess": {
        "username": "admin"
      },
      "createdAt": 1733214198413,
      "updatedAt": 0
    }
  }
}

Update Registry

Mutation · container_updateContainerRegistry

Updates an existing container registry.

Arguments

NameTypeRequiredDescription
inputcontainer_UpdateContainerRegistryInputYesRegistry configuration

input

FieldTypeRequiredDescription
containerRegistryIdStringYesID of registry
hostStringYesThe host of registry
usernameStringYesThe username of registry
accessTokenStringYesThe accessToken of registry

Variables

{
  "input": {
    "username": "admin",
    "host": "test.com",
    "containerRegistryId": "674ebff6c12192a423b48b2d",
    "accessToken": "12345"
  }
}

Request

mutation updateRegistry($input: container_UpdateContainerRegistryInput!) {
  container_updateContainerRegistry(input: $input) {
    id
    mysabayUserId
    name
    host
    userAccess
    createdAt
    updatedAt
  }
}

Response

{
  "data": {
    "container_updateContainerRegistry": {
      "id": "674ebff6c12192a423b48b2d",
      "mysabayUserId": 39555695,
      "name": "custom",
      "host": "nasfong.com",
      "userAccess": {
        "username": "admin"
      },
      "createdAt": 1733214198413,
      "updatedAt": 1733214222662
    }
  }
}

Remove Registry

Mutation · container_deleteContainerRegistryById

Removes a container registry.

Arguments

NameTypeRequiredDescription
containerRegistryIdStringYesThe ID of the registry

Variables

{
  "containerRegistryId": "674ebff6c12192a423b48b2d"
}

Request

mutation Container_deleteContainerRegistryById($containerRegistryId: String!) {
  container_deleteContainerRegistryById(
    containerRegistryId: $containerRegistryId
  ) {
    message
    success
  }
}

Response

{
  "data": {
    "container_deleteContainerRegistryById": {
      "message": "Registry delete successfully",
      "success": true
    }
  }
}