Skip to main content

Get application component connections

GET 
/applications/:applicationId/components/:applicationComponentId/connections


Retrieves the configuration of connected services for given component. Either (build) version or (git) branch must be provided as query parameter to specify the requested configuration version.

Request​

Path Parameters

    applicationId stringrequired

    Possible values: non-empty

    applicationComponentId stringrequired

    Possible values: non-empty

Query Parameters

    version string
    branch string

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

200 response

Schema

    connections

    object[]

    required


    An object containing the runtime configuration of the application component. It represents the configuration file .codenow.config.yaml.

  • Array [

    • name stringrequired


    The user-friendly name or label for the connection.

    type stringrequired


    An internal identifier for the service scaffold, determined by the service type or brand in the case of managed services, or by the template ID for external services.

    templateType ServiceTemplateType (string)required

    Possible values: [MANAGED_COMPONENT, EXTERNAL]


    The template type is closely associated with the service type and indicates whether it is a MANAGED service, provided and maintained by CodeNOW,or EXTERNAL service, defined by the user and maintained independently outside of CodeNOW.

    instanceId string


    The unique identifier of the specific service instance connected to the component. The type of this service instance must match the type attribute.

  • ]

Loading...