API reference - Modular Cloud Studio on AWS
POST /modules/deregisteredPOST /modules/disabledGET /modules/enabledPOST /modules/enabledGET /modules/partnerPUT /modules/partner/syncGET /modules/registeredPOST /modules/registeredGET /modules/registered/inputsGET /modules/validateGET /regionsPUT /regions

API reference

This section provides an API reference for the MCS solution.

POST /modules/deregistered

Body parameter schema

{
 "module_name": "string"
}

Parameters

Name In Type Required Description

body

body

object

true

none

⇒ module_name

body

string

false

none

POST /modules/disabled

Body parameter schema

Parameters 

{
  "disable": {
    "name": "string",
    "servicecatalogProvisionedProductId": "string",
    "moduleRegion": "string",
    "regionType": "string"
  }
}
Name In Type Required Description

body

body

object

true

none

⇒ disable

body

object

false

none

⇒⇒ name

body

string

false

none

⇒⇒ servicecatalogProvisionedProductId

body

string

false

none

⇒⇒ moduleRegion

body

string

false

none

⇒⇒ regionType

body

string

false

none

GET /modules/enabled

Response schema

Status code 200

Name Type Required Restrictions Description

⇒ name

string

false

none

none

⇒ servicecatalogProvisionedProductId

string

false

none

none

⇒ version

string

false

none

none

⇒ region

string

false

none

none

⇒ category

string

false

none

none

⇒ lastUpdateTime

string

false

none

none

⇒*creationTime*

string

false

none

none

⇒ status

string

false

none

none

⇒ cloudformationInputParameters

[object]

false

none

none

⇒⇒ Value

string

false

none

none

⇒⇒ Key

string

false

none

none

⇒ consoleUrl

string

false

none

none

⇒ stackId

string

false

none

none

⇒ activeDependents

[string]

false

none

none

⇒ regionType

string

false

none

none

⇒ moduleRegionCategory

string

false

none

none

POST /modules/enabled

Body parameter schema

{
  "module": {
    "name": "string",
    "version": "string",
    "region": "string",
    "regionType": "string",
    "tags": {
      "useMCSTags": true,
      "customTags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    },
    "inputParameters": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

Parameters

Name In Type Required Description

body

body

object

true

none

⇒ module

body

object

false

none

⇒⇒ name

body

string

false

none

⇒⇒ version

body

string

false

none

⇒⇒ region

body

string

false

none

⇒⇒ regionType

body

string

false

none

⇒⇒ tags

body

object

false

none

⇒⇒⇒ useMCSTags

body

boolean

false

If set to true, non-internal tags from MCS Core stack are used.

⇒⇒⇒ customTags

body

[object]

false

This field is ignored if useMCSTags is set to true. Otherwise, the tags from this field will are used.

⇒⇒⇒⇒ Key

body

string

false

none

⇒⇒⇒⇒ Value

body

string

false

none

⇒⇒ inputParameters

body

[object]

false

none

⇒⇒⇒ Key

body

string

false

none

⇒⇒⇒Value

body

string

false

none

GET /modules/partner

Example responses

200 response

Name Meaning Description Schema

200

OK

200 response

Inline

Response schema

Status code 200

Name Type Required Restrictions Description

⇒ modules

[object]

false

none

none

⇒⇒ name

string

false

none

none

⇒⇒ displayName

string

false

none

none

⇒⇒ category

string

false

none

none

⇒⇒ manifestUrl

string

false

none

none

⇒⇒ status

string

false

none

none

⇒⇒ createAt

string

false

none

none

⇒⇒ updatedAt

string

false

none

none

⇒⇒ isCustom

boolean

false

none

none

⇒ last_updated_date

string

false

none

none

PUT /modules/partner/sync

Body parameter schema

Request body must be empty

Example responses

202 response

Name Meaning Description Schema

202

Accepted

Partner module synchronization started successfully.

Inline

409

Conflict

Partner modules are being synchronized and/or registered by another process.

Inline

502

Bad Gateway

An error occurred with the remote server hosting the partner module manifests.

Inline

GET /modules/registered

Example responses

200 response

Name Meaning Description Schema

200

OK

200 response

Inline

Response schema

Status code 200

Name Type Required Restrictions Description

⇒ name

string

false

none

none

⇒ version

string

false

none

none

⇒ status

string

false

none

none

⇒ category

string

false

none

none

⇒ serviceCatalogPortfolioId

string

false

none

none

⇒ serviceCatalogProductId

string

false

none

none

⇒ inputParametersLocal

[string]

false

none

none

⇒ inputParametersHub

[string]

false

none

none

⇒ regionType

string

false

none

none

⇒ isExternal

boolean

false

none

none

POST /modules/registered

Body parameter schema

{
  "params": {
    "manifestUrl": "string",
    "revision": "string"
  }
}

Parameters

Name In Type Required Description

body

body

object

true

none

⇒ params

body

object

false

none

⇒⇒ manifestUrl

body

string

false

none

⇒⇒ revision

body

string

false

none

Example responses

200 response

Status Meaning Description Schema

200

OK

200 response

Inline

GET /modules/registered/inputs

Parameters

Name In Type Required Description

name

query

string

true

none

version

query

string

true

none

region

query

string

true

none

regionType

query

string

true

Either HUB or SPOKE

Response schema

Status code 200

Name Type Required Restrictions Description

⇒ cloudformationInputKeys

[object]

false

none

none

⇒⇒ name

string

false

none

none

⇒⇒ category

string

false

none

none

⇒⇒ constraints

object

false

none

none

⇒⇒⇒ allowedPattern

string

false

none

none

⇒⇒⇒ allowedValues

[string]

false

none

none

⇒⇒ default

string

false

none

none

⇒⇒ description

string

false

none

none

⇒ mcsTags

[object]

false

none

none

⇒⇒ key

string

false

none

none

⇒⇒ value

string

false

none

none

GET /modules/validate

Parameters

Name In Type Required Description

manifest_url

query

string

true

none

Response schema

Status code 200

Name Type Required Restrictions Description

⇒ data

object

false

none

Represents the manifest JSON file defined in the developer guide

GET /regions

Response schema

Status code 200

Name Type Required Restrictions Description

⇒ regions

[object]

false

none

none

⇒⇒ name

string

false

none

none

⇒⇒ isHub

boolean

false

none

none

⇒⇒ enablementStatus

string

false

none

none

⇒⇒ provisionedProductId

string

false

none

none

⇒⇒ dateEnabled

string

false

none

none

PUT /regions

Body parameter schema

{
  "region": {
    "name": "string",
    "enablementStatus": "string"
  }
}

Parameters

Name In Type Required Description

body

body

object

true

none

⇒ region

body

object

false

none

⇒⇒ name

body

string

false

none

⇒⇒ enablementStatus

body

string

false

none

Response schema

Status code 200

Name Type Required Restrictions Description

⇒ regions

object

false

none

none

⇒⇒ name

string

false

none

none

⇒⇒ isHub

string

false

none

none

⇒⇒ enablementStatus

string

false

none

none

⇒⇒ provisionedProductId

string

false

none

none

⇒⇒ dateEnabled

string

false

none

none