Namirasoft Container Registry API V1

Namira Software Corporation Container Registry API Version 1 (1.4.3)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-container-registry-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-container-registry healthz get

Copied!

Metrics

Get

Returns the application metrics

ns-container-registry metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-container-registry value list {table} {column} {search} {field_id} {limit}

Copied!

ContainerRegistryCategory

List

Returns the container registry category list

ns-container-registry containerregistrycategory list {filters} {page} {size} {sorts}

Copied!

Get

Returns a container registry category by id.

ns-container-registry containerregistrycategory get {id}

Copied!

Create

Creates a new container registry category for an entity

ns-container-registry containerregistrycategory create {entity_id}

Copied!

--category_id (String)

Delete

Deletes a container registry category by an id.

ns-container-registry containerregistrycategory delete {entity_id} {id}

Copied!

ContainerRegistryField

List

Returns the container registry field list

ns-container-registry containerregistryfield list {filters} {page} {size} {sorts}

Copied!

Get

Returns a container registry field by id.

ns-container-registry containerregistryfield get {id}

Copied!

Create

Creates a new container registry field for an entity

ns-container-registry containerregistryfield create {entity_id}

Copied!

--field_id (String)

--value (Any)

Update

Updates a container registry field by an id for an entity

ns-container-registry containerregistryfield update {entity_id} {id}

Copied!

--field_id (String)

--value (Any)

Delete

Deletes a container registry field by an id.

ns-container-registry containerregistryfield delete {entity_id} {id}

Copied!

ContainerRegistryTag

List

Returns the container registry tag list

ns-container-registry containerregistrytag list {filters} {page} {size} {sorts}

Copied!

Get

Returns a container registry tag by id.

ns-container-registry containerregistrytag get {id}

Copied!

Create

Creates a new container registry tag for an entity

ns-container-registry containerregistrytag create {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a container registry tag by an id for an entity

ns-container-registry containerregistrytag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a container registry tag by an id.

ns-container-registry containerregistrytag delete {entity_id} {id}

Copied!

ContainerRegistry

List

Returns the container registry list

ns-container-registry containerregistry list {filters} {page} {size} {sorts}

Copied!

Get

Returns a container registry by an id

ns-container-registry containerregistry get {id}

Copied!

Delete

Deletes a container registry by an id

ns-container-registry containerregistry delete {id}

Copied!

AWSECR

Create

Creates a new aws ecr

ns-container-registry awsecr create

Copied!

--name (String)

--type (Enum)

--description (String)

--aws_credential_id (String)

Update

Updates an aws ecr by an id

ns-container-registry awsecr update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--aws_credential_id (String)

AzureACR

Create

Creates a new azure acr

ns-container-registry azureacr create

Copied!

--name (String)

--type (Enum)

--description (String)

--azure_credential_id (String)

Update

Updates an azure acr by an id

ns-container-registry azureacr update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--azure_credential_id (String)

GitHubContainerRegistry

Create

Creates a new git hub container registry

ns-container-registry githubcontainerregistry create

Copied!

--name (String)

--type (Enum)

--description (String)

--git_hub_credential_id (String)

Update

Updates a git hub container registry by an id

ns-container-registry githubcontainerregistry update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--git_hub_credential_id (String)

GitLabContainerRegistry

Create

Creates a new git lab container registry

ns-container-registry gitlabcontainerregistry create

Copied!

--name (String)

--type (Enum)

--description (String)

--git_lab_credential_id (String)

Update

Updates a git lab container registry by an id

ns-container-registry gitlabcontainerregistry update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--git_lab_credential_id (String)

GoogleArtifactRegistry

Create

Creates a new google artifact registry

ns-container-registry googleartifactregistry create

Copied!

--name (String)

--type (Enum)

--description (String)

--gcp_credential_id (String)

Update

Updates a google artifact registry by an id

ns-container-registry googleartifactregistry update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--gcp_credential_id (String)

GoogleContainerRegistry

Create

Creates a new google container registry

ns-container-registry googlecontainerregistry create

Copied!

--name (String)

--type (Enum)

--description (String)

--gcp_credential_id (String)

Update

Updates a google container registry by an id

ns-container-registry googlecontainerregistry update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--gcp_credential_id (String)

Harbor

Create

Creates a new harbor

ns-container-registry harbor create

Copied!

--name (String)

--type (Enum)

--description (String)

--harbor_credential_id (String)

Update

Updates a harbor by an id

ns-container-registry harbor update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--harbor_credential_id (String)

JFrogArtifactory

Create

Creates a new jfrog artifactory

ns-container-registry jfrogartifactory create

Copied!

--name (String)

--type (Enum)

--description (String)

--jfrog_artifactory_credential_id (String)

Update

Updates a jfrog artifactory by an id

ns-container-registry jfrogartifactory update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--jfrog_artifactory_credential_id (String)

PrivateRegistry

Create

Creates a new private registry

ns-container-registry privateregistry create

Copied!

--name (String)

--type (Enum)

--description (String)

--basic_auth_credential_id (String)

Update

Updates a private registry by an id

ns-container-registry privateregistry update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--basic_auth_credential_id (String)

PublicRepository

Create

Creates a new public repository

ns-container-registry publicrepository create

Copied!

--name (String)

--type (Enum)

--description (String)

Update

Updates a public repository by an id

ns-container-registry publicrepository update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

SonatypeNexus

Create

Creates a new sonatype nexus

ns-container-registry sonatypenexus create

Copied!

--name (String)

--type (Enum)

--description (String)

--sonatype_nexus_credential_id (String)

Update

Updates a sonatype nexus by an id

ns-container-registry sonatypenexus update {id}

Copied!

--name (String)

--type (Enum)

--description (String)

--sonatype_nexus_credential_id (String)

Schemas


ContainerRegistryCategory

{
  "name": "ContainerRegistryCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityCategoryInput

{
  "name": "EntityCategoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    }
  }
}

ContainerRegistryField

{
  "name": "ContainerRegistryField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityFieldInput

{
  "name": "EntityFieldInput",
  "type": "Object",
  "required": true,
  "fields": {
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "Any",
      "required": false
    }
  }
}

ContainerRegistryTag

{
  "name": "ContainerRegistryTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

ContainerRegistry

{
  "name": "ContainerRegistry",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "meta": {
      "type": "Any",
      "required": false
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

AWSECRInput

{
  "name": "AWSECRInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "aws_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

AzureACRInput

{
  "name": "AzureACRInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "azure_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

GitHubContainerRegistryInput

{
  "name": "GitHubContainerRegistryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "git_hub_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

GitLabContainerRegistryInput

{
  "name": "GitLabContainerRegistryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "git_lab_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

GoogleArtifactRegistryInput

{
  "name": "GoogleArtifactRegistryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "gcp_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

GoogleContainerRegistryInput

{
  "name": "GoogleContainerRegistryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "gcp_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

HarborInput

{
  "name": "HarborInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "harbor_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

JFrogArtifactoryInput

{
  "name": "JFrogArtifactoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "jfrog_artifactory_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

PrivateRegistryInput

{
  "name": "PrivateRegistryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "basic_auth_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

PublicRepositoryInput

{
  "name": "PublicRepositoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    }
  }
}

SonatypeNexusInput

{
  "name": "SonatypeNexusInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContainerRegistryType",
      "type": "Enum",
      "required": true,
      "valids": [
        "PublicRepository",
        "AWSECR",
        "AzureACR",
        "GoogleContainerRegistry",
        "GoogleArtifactRegistry",
        "SonatypeNexus",
        "JFrogArtifactory",
        "Harbor",
        "GitHubContainerRegistry",
        "GitLabContainerRegistry",
        "PrivateRegistry"
      ]
    },
    "description": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "sonatype_nexus_credential_id": {
      "type": "String",
      "required": true
    }
  }
}

Enums

ContainerRegistryType

PublicRepository

AWSECR

AzureACR

GoogleContainerRegistry

GoogleArtifactRegistry

SonatypeNexus

JFrogArtifactory

Harbor

GitHubContainerRegistry

GitLabContainerRegistry

PrivateRegistry

Namira Software Corporation

©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.