Skip to main content

Get a managed service

GET 
/managed-services/:serviceId

The operation allows you to retrieve details about a specific managed service. Managed services are specialized resources provided and maintained by CodeNOW designed to streamline and handle specific functions.

Request​

Path Parameters

    serviceId stringrequired

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

Managed service detail

Schema

    id stringrequired


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

    displayName stringrequired


    The user-friendly name or label for the service. It allows users to provide a clear and descriptive name that helps in identifying and distinguishing different services easily. The field accepts free text with alphanumeric and special characters.

    description string


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

    templateId stringrequired


    An internal identifier of the scaffold used for service creation. It also provides information about the type or brand of the service.

    templateVersion stringrequired


    The version of the scaffold used for service creation.

    environmentId stringrequired


    The unique identifier of the environment where the service will be deployed. To obtain this identifier, use the GET /environments operation to retrieve a list of available environments.
    This value is NOT set for a service of type "ENTERPRISE".

    status ManagedServiceStatus (string)required

    Possible values: [READY, CREATING, UPDATING, DELETING, UNKNOWN, DOWN, FAILED_TO_CREATE, FAILED_TO_UPDATE]

    Status of the managed service
    READY - Service is ready
    CREATING - Creating service
    UPDATING - Updating service
    DELETING - Deleting service
    UNKNOWN - Status is unknown
    DOWN - Service is down / not usable
    FAILED_TO_CREATE - Service could not be created
    FAILED_TO_UPDATE - Service could not be updated

    createdAt date-time


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

    createdBy string


    The username of the user who initialized the creation of the managed service.

    type stringrequired


    The service type by management with two possible values: MANAGED for a service provided and managed by CodeNOW, or ENTERPRISE for a service managed by the customer outside of CodeNOW.

    accessControl

    object

    required


    An object specifying which environments are allowed to access the service via the Connect Services feature of Application Components.

    unlimited boolean


    A boolean flag indicating whether all user-defined environments can access the service via the Connect Services feature of Application Components.If set to false, only the environments specified in allowFrom will be able to connect.

    allowFrom string[]nullable


    A list of IDs of all environments, from which the service can be accessed via the Connect Services feature of Application Components.To obtain these identifiers, use the GET /environments operation to retrieve a list of available environments.
    This field should only be specified, when unlimited is set to false or null!

    adminConsoleUrl stringnullable


    The URL providing direct access to the service's specific management interface.

    errorCode stringnullable


    The error code returned if the service creation failed.

    errorMessage stringnullable


    The error message returned if the service creation failed.

Loading...