Skip to main content

Update application component connections

PUT 

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

Update application component connections

Request

Path Parameters

    applicationId stringrequired

    Possible values: non-empty

    applicationComponentId stringrequired

    Possible values: non-empty

Query Parameters

    branch stringrequired

    Possible values: non-empty

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Body

required

    connections

    object[]

    required


    A list of all needed connected services, denoted by connection name, service type and a specific instance.
    Providing an empty list will remove all connections.

  • Array [

  • name stringrequired

    Possible values: non-empty


    The user-friendly name or label for the connection. Must be unique per component, upper-case and contain no spaces (underscores are allowed).

    type stringrequired

    Possible values: non-empty


    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.

    instanceId string


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

  • ]

Responses

application-component-connections-update 200 response

Schema

    status stringrequired

    Possible values: non-empty

Loading...