Skip to main content

Create a managed service

POST 
/managed-services

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

Request​

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Body

required

    name stringrequired

    Possible values: >= 3 characters and <= 30 characters


    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.
    CodeNOW will generate an ID for the service based on this name.

    description stringnullable


    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.

    template

    object

    required


    An object specifying the scaffold that should be used for service creation. It includes information about the selected service type, scaffold version and configuration properties.

    To obtain possible values, use the GET /templates/managed_services to retrieve list of available templates.
    And then use the GET /templates/managed_services/:templateId to obtain list of available template properties.

    id stringrequired

    Possible values: non-empty


    An internal identifier of the scaffold selected for library creation.It includes information about the selected language, build tool and framework, if specified.

    version stringrequired

    Possible values: non-empty


    The desired version of the selected template. It is only required if multiple versions of the template are available.

    properties

    object


    A map of properties ("key": "value") required for proper template configuration.

    property name* string
    environmentId stringrequired

    Possible values: non-empty


    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.

    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!

Responses​

Managed service detail

Schema

    id string
    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.

    createdBy stringrequired


    The username of the user who initialized the creation 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.

    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.

Loading...