Skip to main content

List of containers

GET 
/containers

The operation allows you to retrieve a collection of all available containers. A container constitutes a collection of pre-written and reusable code components, functions, and modules that enhance software development efficiency.

Request​

Query Parameters

    allowedOps string[]

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

List of containers

Schema

  • Array [

    • id stringrequired


    The unique identifier of the container. Based on the user-defined container name.

    name stringrequired


    The user-friendly name of the container. It allows users to provide a clear and descriptive name that helps in identifying and distinguishing different containers easily. The field accepts free text with alphanumeric and special characters.

    description stringnullable


    The detailed textual description of the container. Allows users to add additional context, notes, or any relevant information about the purpose, usage, or characteristics of the container.

    state ContainerState (string)required

    Possible values: [CREATING, READY, FAILED, DELETING]

    State of the container
    CREATING - Container is being created
    READY - Container is ready
    FAILED - Container creation failed
    DELETING - Container is being deleted

    error

    object

    nullable


    Error details, if any, encountered during the container creation process.

    code string
    message string

    scm

    object

    required


    An object containing Source Code Management (SCM) information, including provider, repository/project ID, HTTP clone URL, and SSH clone URL.

    provider stringnullable


    The name of the SCM provider associated with the container, facilitating version control and collaborative software development.

    providerType stringnullable


    CI Provider type (github, codenow, etc)

    id stringnullable


    The unique identifier of the container repository or project within the SCM system.

    sshAddress stringrequired


    The SSH address string required for performing a Git clone operation on the repository linked to the container.

    httpAddress stringrequired


    The HTTP address string required for performing a Git clone operation on the repository linked to the container.

    settings

    object

    required

    Basic settings for the container

    maxQueueSize int32required

    Maximum number of builds with accessible logs before they are archived

    ciSettings

    object

    required

    CI settings for the container

    provider stringnullable


    Associated CI provider:
    codenow - uses CodeNow CI
    external - uses external CI

    availableProviders string[]nullable


    List of CI providers that are configurable for the container.

    globalPipelinesConfiguration booleannullable


    A boolean flag indicating whether pipeline settings are globally configured for the entire repository. If set to false, the pipeline settings are independently customized for individual branches.

    createdAt date-timenullable


    The timestamp when the container was created. If the timestamp is unknown, the value will be returned as null.

    createdBy stringnullable


    This field represents the identifier of the user responsible for creating the container. If the user is unknown, the value will be returned as null.

  • ]

Loading...