{
"openapi": "3.0.1",
"info": {
"title": "meshStack API documentation",
"version": "1.0.0"
},
"servers": [
{
"url": "https://{apiUrl}",
"variables": {
"apiUrl": {
"default": "example.meshstack.io"
}
}
}
],
"tags": [
],
"paths": {
"/api": {
"get": {
"tags": [
"API Root"
],
"summary": "API Root",
"description": "Access the root endpoint of the meshfed API to discover available API resources\n\n**Authentication:** This endpoint supports multiple authentication methods: API User authentication or API Key authentication.",
"operationId": "apiRoot",
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/apiRoot"
},
"examples": {
"apiRoot": {
"value": "{\n \"_links\" : {\n \"metadata\" : {\n \"href\" : \"https://mesh-backend-url/api/metadata\"\n },\n \"meshobjects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
},
{
"basic": [
]
}
]
}
},
"/api/login": {
"post": {
"tags": [
"API Key Login"
],
"summary": "API Key Login",
"description": "To call the API with an API Key, first issue an API call to the backend to receive a short-lived bearer token.\nSend a request to `/api/login` with the following keys in the body of the request. You can use either the `x-www-form-urlencoded` format or the `application/json` format:\n\n- For `x-www-form-urlencoded`, provide the parameters `client_id`, `client_secret`, and `grant_type` in the\n request body. This variant will respond with a redirect to meshStack's IdP. You must configure your client to\n follow the redirect or handle it manually.\n- For `application/json`, provide a JSON object with `clientId` and `clientSecret` fields. This variant will\n respond directly with an access token and related fields, without a redirect. **We recommend using the JSON\n variant for most integrations.**\n\nChoose the format that best fits your integration scenario, but prefer the JSON variant for simplicity and direct access to the token.",
"operationId": "apiKeyLoginResponse",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/api-login2002944754"
},
"examples": {
"apiKeyLoginResponseRedirect": {
"value": "client_id=0472dc6f-2272-4696-88c9-f912ad612b4c&client_secret=KDihg8m6hzUhbKDqY1d0WIWuBoKkDzQ0&grant_type=client_credentials"
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-login-582311654"
},
"examples": {
"apiKeyLoginResponse": {
"value": "{\n \"clientId\" : \"0472dc6f-2272-4696-88c9-f912ad612b4c\",\n \"clientSecret\" : \"KDihg8m6hzUhbKDqY1d0WIWuBoKkDzQ0\"\n} "
}
}
}
}
},
"responses": {
"307": {
"description": "307"
},
"200": {
"description": "200",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apiKeyLoginResponse"
},
"examples": {
"apiKeyLoginResponse": {
"value": "{\n \"access_token\" : \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJPdXJGaUduQnB2QlZNY2NBRjVNT1J3bTA3ODRObHZHRlFXSjlmdm8wTklzIn0.eyJleHAiOjE3ODA0OTU3OTQsImlhdCI6MTc4MDQ5NTQ5NCwianRpIjoidHJydGNjOmE5NWVmZWQ2LWM3M2YtMmFjNi0wNmY2LTc0NjYzNmVmZGUzYyIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NTA1MC9hdXRoL3JlYWxtcy9tZXNoZmVkIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjI1Yjc1MDI2LWRlNDYtNDA5Mi04ZDlhLWMyNGNjMWNiZmUwNiIsInR5cCI6IkJlYXJlciIsImF6cCI6IjA0NzJkYzZmLTIyNzItNDY5Ni04OGM5LWY5MTJhZDYxMmI0YyIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLW1lc2hmZWQiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImNsaWVudEhvc3QiOiIxMjcuMC4wLjEiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByZWZlcnJlZF91c2VybmFtZSI6InNlcnZpY2UtYWNjb3VudC0wNDcyZGM2Zi0yMjcyLTQ2OTYtODhjOS1mOTEyYWQ2MTJiNGMiLCJjbGllbnRBZGRyZXNzIjoiMTI3LjAuMC4xIiwiY2xpZW50X2lkIjoiMDQ3MmRjNmYtMjI3Mi00Njk2LTg4YzktZjkxMmFkNjEyYjRjIn0.bVJldBvzvsa6uK-0do6tmuHCyDZoo15Th4hUV5nA3JI47mB_Ueo0u-I0Xy-Ws67cQ-dCwLrgjRfEoAbmvz3Ax7lElBeOW_JC3EEMTTfYb7i-uQV8tO0pWFPT4vcDF_7ZowyTweJ5KQuiJxUSwfFkMK71_5Fjb_UULnEOq3sKFswS6x22SjgMLgJZcbMO75hoIVuzOnsi_ORTFbGidfkINnLtVLt5FTWcwToFqjyJfwt3BiiHMnugdsnr0lVF1IvqUVrXkSGD8SWladrmLVFlyyn1OZ1aXCB5icToqBI0vuNpDM4hDWYWdqp5p0pIVHnp_yMoQwUrA4nOVNTM5ApoZQ\",\n \"expires_in\" : 300,\n \"refresh_expires_in\" : 0,\n \"token_type\" : \"Bearer\",\n \"not-before-policy\" : 0,\n \"scope\" : \"profile email\"\n}"
}
}
}
}
}
},
"security": [
]
}
},
"/api/meshobjectcollections": {
"post": {
"tags": [
"meshObjectCollections"
],
"summary": "Create a meshObjectCollection",
"description": "This endpoint will create a new empty meshObjectCollection. You can use collections for declarative deletion.\nCurrently supported objects are: meshWorkspaceUserGroup, meshWorkspaceUserBinding & meshWorkspaceGroupBinding.\nDeclarative deletion means that a previously imported resource will be deleted, if it is not specified in a subsequent import.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "createMeshObjectCollection",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "meshObjectCollections are versioned and currently only support `application/vnd.meshcloud.api.meshobjectcollection.v1+json` as a `Content-Type`.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshobjectcollection.v1+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshobjectcollection.v1+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjectcollections1637419709"
},
"examples": {
"createMeshObjectCollection": {
"value": "\n {\n \"name\": \"collection-name\",\n \"owner\": \"collection-owner\",\n \"description\": \"This is a meshObjectCollection.\"\n }\n "
}
}
}
}
},
"responses": {
"201": {
"description": "201"
}
},
"security": [
{
"basic": [
]
}
]
},
"delete": {
"tags": [
"meshObjectCollections"
],
"summary": "Delete a meshObjectCollection",
"description": "This endpoint can be used to delete an existing meshObjectCollection. It will not remove any meshObjects\nand works only for empty meshObjectCollections. To delete a meshObjectCollection and all assigned\nmeshObjects, those have to be deleted manually before calling this endpoint.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "deleteMeshObjectCollection",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "meshObjectCollections are versioned and currently only support `application/vnd.meshcloud.api.meshobjectcollection.v1+json` as a `Content-Type`.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshobjectcollection.v1+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshobjectcollection.v1+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjectcollections-319085079"
},
"examples": {
"deleteMeshObjectCollection": {
"value": "\n {\n \"name\": \"collection-name\",\n \"owner\": \"collection-owner\"\n }\n "
}
}
}
}
},
"responses": {
"200": {
"description": "200"
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/meshobjects": {
"get": {
"tags": [
"Object Root"
],
"summary": "Get meshObjects root",
"description": "Get the meshObjects root resource with available links\n\n**Authentication:** This endpoint supports multiple authentication methods: API User authentication or API Key authentication.",
"operationId": "meshObjectsRootV",
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshobjects.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshobjects.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshObjectsRootV1"
},
"examples": {
"meshObjectsRootV1": {
"value": "{\n \"_links\" : {\n \"meshserviceinstances\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects{?customerIdentifier,paymentIdentifier}\",\n \"templated\" : true\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants{?customerIdentifier,projectIdentifier,platformIdentifier}\",\n \"templated\" : true\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods{?customerIdentifier}\",\n \"templated\" : true\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects\"\n }\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshobjects.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshObjectsRootV2"
},
"examples": {
"meshObjectsRootV2": {
"value": "{\n \"_links\" : {\n \"meshserviceinstances\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances{?workspaceIdentifier,projectIdentifier,marketplaceIdentifier,serviceIdentifier,planIdentifier,serviceBrokerIdentifier}\",\n \"templated\" : true\n },\n \"meshtagdefinitions\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions\"\n },\n \"meshlandingzones\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones{?identifier,displayName,platformUuid,lifecycleState,restricted,ownedByWorkspace}\",\n \"templated\" : true\n },\n \"mesheventlogs\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/mesheventlogs{?from,until,title,description,authorType,authorIdentifier,eventType,workspaceName,workspaceIdentifier,excludeTitle}\",\n \"templated\" : true\n },\n \"meshbuildingblockdefinitions\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions{?ownedByWorkspace,includeAllPublished}\",\n \"templated\" : true\n },\n \"meshbuildingblockruns\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns?buildingBlockUuid={buildingBlockUuid}\",\n \"templated\" : true\n },\n \"meshbuildingblockrunners\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockrunners{?workspaceIdentifier}\",\n \"templated\" : true\n },\n \"meshbuildingblocks\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks{?workspaceIdentifier,projectIdentifier,platformIdentifier,name,definitionUuid,versionUuid,tenantUuid,targetRefKind,status,managedByWorkspaceIdentifier,managedByDefinitionUuid,lifecycleState}\",\n \"templated\" : true\n },\n \"meshlocations\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlocations{?displayName,lifecycleState}\",\n \"templated\" : true\n },\n \"meshapikeys\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshapikeys{?ownedByWorkspace}\",\n \"templated\" : true\n },\n \"meshintegrations\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations{?displayName,ownedByWorkspace,type}\",\n \"templated\" : true\n },\n \"meshprojectgroupbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings{?workspaceIdentifier,projectIdentifier}\",\n \"templated\" : true\n },\n \"meshprojectuserbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings{?workspaceIdentifier,projectIdentifier}\",\n \"templated\" : true\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects{?workspaceIdentifier,paymentIdentifier,state}\",\n \"templated\" : true\n },\n \"meshplatforms\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms{?searchTerm}\",\n \"templated\" : true\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants{?workspaceIdentifier,projectIdentifier,platformIdentifier,deletionState}\",\n \"templated\" : true\n },\n \"meshworkspaces\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces\"\n },\n \"meshworkspaceuserbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/userbindings{?username,workspaceRole,workspaceIdentifier}\",\n \"templated\" : true\n },\n \"meshworkspacegroupbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/groupbindings{?username,workspaceRole,workspaceIdentifier}\",\n \"templated\" : true\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups{?workspaceIdentifier,username}\",\n \"templated\" : true\n },\n \"meshcommunications\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunications{?communicationDefinitionUuid,resolutionStatus,communicationType}\",\n \"templated\" : true\n },\n \"meshcommunicationdefinitions\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions{?type}\",\n \"templated\" : true\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers{?uuid,workspaceIdentifier,projectIdentifier,platformIdentifier,workspaceUserGroupIdentifier,projectRole,workspaceRole,email,firstName,lastName,username,euid}\",\n \"templated\" : true\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods{?workspaceIdentifier}\",\n \"templated\" : true\n },\n \"meshprojectroles\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles\"\n },\n \"meshplatformtypes\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatformtypes{?category,lifecycleState}\",\n \"templated\" : true\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
},
{
"basic": [
]
}
]
},
"put": {
"tags": [
"meshObject Import"
],
"summary": "Import meshObjects with JSON",
"description": "To import existing cloud tenants to meshStack into existing company processes, meshStack\nprovides an API to import meshObjects like meshWorkspace, meshProject, etc. The Declarative Import allows\nexternal systems to use a PUT request method for importing meshObject definitions within a YAML or JSON\ndefinition. All supported meshObjects can be found under Supported meshObjects.\nmeshObjects can be imported into a meshObjectCollection (`*Beta*`) using the\nfollowing optional request parameters.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "importInJson",
"parameters": [
{
"name": "meshObjectCollection",
"in": "query",
"description": "the name of the meshObjectCollection the meshObjects should be imported into",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "owner",
"in": "query",
"description": "If meshObjectCollection parameter is provided, this is the owner of the meshObjectCollection",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "meshObject Import is versioned and `application/vnd.meshcloud.api.meshobjects.v1+yaml` or `application/vnd.meshcloud.api.meshobjects.v1+json` can be used as a `Content-Type`.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshobjects.v1+json"
},
{
"name": "Accept",
"in": "header",
"description": "meshObject Import is versioned and you should use `application/vnd.meshcloud.api.meshobjects.v1+json` as an `Accept` header to be guaranteed the V1 response format of this endpoint. New versions will be added in future.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshobjects.v1+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshobjects.v1+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectroles486549215"
},
"examples": {
"importInJson": {
"value": "[\n {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshUser\",\n \"metadata\": {\n \"name\": \"test-user\"\n },\n \"spec\": {\n \"email\": \"test1-user@meshcloud.io\",\n \"firstName\": \"test-user-first-name\",\n \"lastName\": \"test-user-last-name\",\n \"euid\": \"test-euid\"\n }\n },\n {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshWorkspace\",\n \"metadata\": {\n \"name\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-display-name\", \n \"tags\": {\n \"costCenter\": [\n \"2411\",\n \"9122\"\n ],\n \"workspaceOwner\": [\n \"Anna Admin\"\n ]\n }\n }\n }\n]"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshobjects.v1+json": {
"schema": {
"$ref": "#/components/schemas/importInJson"
},
"examples": {
"importInJson": {
"value": "[ {\n \"meshObject\" : \"meshUser[test-user]\",\n \"status\" : \"SUCCESS\",\n \"resultCode\" : null,\n \"message\" : null,\n \"remarks\" : null\n}, {\n \"meshObject\" : \"meshWorkspace[test-workspace]\",\n \"status\" : \"SUCCESS\",\n \"resultCode\" : null,\n \"message\" : null,\n \"remarks\" : null\n} ]"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/metadata": {
"get": {
"tags": [
"Openstack Metadata"
],
"summary": "Metadata Root",
"description": "Access the root endpoint of the metadata API to discover available metadata endpoints\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "metadataRoot",
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.metadata.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.metadata.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/metadataRoot"
},
"examples": {
"metadataRoot": {
"value": "{\n \"_links\" : {\n \"openstackProjectMetadata\" : {\n \"href\" : \"https://mesh-backend-url/api/metadata/openstackProjectMetadata\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/metadata\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshapikeys": {
"get": {
"tags": [
"API Keys"
],
"summary": "List API keys",
"description": "List meshApiKeys owned by a workspace.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshApiKey-List",
"parameters": [
{
"name": "ownedByWorkspace",
"in": "query",
"description": "Filter by workspace identifier. Required for workspace-scoped API keys (automatically enforced). Optional for admin API keys, which can list keys across all workspaces when omitted.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshApiKey-List"
},
"examples": {
"meshApiKey-List": {
"value": "{\n \"_embedded\" : {\n \"meshApiKeys\" : [ {\n \"kind\" : \"meshApiKey\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\",\n \"ownedByWorkspace\" : \"apikey-workspace\",\n \"createdOn\" : \"2026-06-03T14:05:01.977263448Z\"\n },\n \"spec\" : {\n \"displayName\" : \"temporary-api-key\",\n \"permissions\" : [ \"BUILDINGBLOCK_LIST\" ],\n \"expiresAt\" : \"2026-07-03\"\n },\n \"status\" : {\n \"clientId\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshapikeys/623db4e9-8b3e-4edf-8828-8cda5e96befe\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshapikeys?ownedByWorkspace=apikey-workspace&page=0&size=20\"\n }\n },\n \"page\" : {\n \"size\" : 20,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"API Keys"
],
"summary": "Create API key",
"description": "Create a new API key.\n\nThe response contains the API key secret exactly once in `status.clientSecret`.\nSubsequent GET responses will not include `status.clientSecret`.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshApiKey-Post",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshapikeys1956798473"
},
"examples": {
"meshApiKey-Post": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshApiKey\",\n \"metadata\": {\n \"ownedByWorkspace\": \"apikey-workspace\"\n },\n \"spec\": {\n \"displayName\": \"temporary-api-key\",\n \"permissions\": [\"BUILDINGBLOCK_LIST\"],\n \"expiresAt\": \"2026-07-03\"\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshApiKey-Post"
},
"examples": {
"meshApiKey-Post": {
"value": "{\n \"kind\" : \"meshApiKey\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\",\n \"ownedByWorkspace\" : \"apikey-workspace\",\n \"createdOn\" : \"2026-06-03T14:05:01.977263448Z\"\n },\n \"spec\" : {\n \"displayName\" : \"temporary-api-key\",\n \"permissions\" : [ \"BUILDINGBLOCK_LIST\" ],\n \"expiresAt\" : \"2026-07-03\"\n },\n \"status\" : {\n \"clientId\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\",\n \"clientSecret\" : \"kDW8fLad6LwoXSyemEIljWPGW0rTTKxe\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshapikeys/623db4e9-8b3e-4edf-8828-8cda5e96befe\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockdefinitions": {
"get": {
"tags": [
"Building Block Definitions"
],
"summary": "List building block definitions",
"description": "List all meshBuildingBlockDefinitions with optional filtering by workspace and pagination support. When includeAllPublished is set to true, released and published definitions from all workspaces are returned to enable cross-workspace discovery of building blocks, similar to the marketplace experience.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionListV1",
"parameters": [
{
"name": "ownedByWorkspace",
"in": "query",
"description": "Filter for Building Block Definitions that are owned by the meshWorkspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "includeAllPublished",
"in": "query",
"description": "When set to true, includes released and published definitions from all workspaces, enabling cross-workspace discovery of building blocks similar to the marketplace. (optional, default: false)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionListV1"
},
"examples": {
"meshBuildingBlockDefinitionListV1": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockDefinitions\" : [ {\n \"kind\" : \"meshBuildingBlockDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"ownedByWorkspace\" : \"my-workspace\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"4kkx3mbbdds1\",\n \"symbol\" : \"my-image\",\n \"targetType\" : \"TENANT_LEVEL\",\n \"description\" : \"description\",\n \"supportedPlatforms\" : [ {\n \"name\" : \"AZURE\",\n \"kind\" : \"meshPlatformType\"\n } ],\n \"runTransparency\" : false,\n \"useInLandingZonesOnly\" : false,\n \"supportUrl\" : \"https://example-support.com\",\n \"documentationUrl\" : \"https://example-docs.com\",\n \"notificationSubscriberUsernames\" : [ ]\n },\n \"status\" : {\n \"versions\" : [ {\n \"versionUuid\" : \"2ed7a604-913e-4b75-b9fb-5d6aa3618819\",\n \"versionNumber\" : 1,\n \"state\" : \"RELEASED\"\n } ],\n \"latestVersion\" : 1,\n \"latestVersionUuid\" : \"2ed7a604-913e-4b75-b9fb-5d6aa3618819\",\n \"latestReleasedVersion\" : 1,\n \"latestReleasedVersionUuid\" : \"2ed7a604-913e-4b75-b9fb-5d6aa3618819\",\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:03.007548547Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/b23cfb9a-6974-444f-9d33-62134a632373\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/my-workspace\"\n },\n \"buildingblocks\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks?definitionUuid=b23cfb9a-6974-444f-9d33-62134a632373\"\n },\n \"versions\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=b23cfb9a-6974-444f-9d33-62134a632373\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions?ownedByWorkspace=my-workspace&includeAllPublished=true&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Building Block Definitions"
],
"summary": "Create building block definition",
"description": "Create a new meshBuildingBlockDefinition with specified configuration and workspace ownership\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionPostV1",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockdefinitions519685334"
},
"examples": {
"meshBuildingBlockDefinitionPostV1": {
"value": "{\n \"apiVersion\" : \"v1-preview\",\n \"kind\" : \"meshBuildingBlockDefinition\",\n \"metadata\" : {\n \"ownedByWorkspace\": \"my-workspace\"\n },\n \"spec\" : {\n \"targetType\": \"TENANT_LEVEL\",\n \"displayName\": \"BB definition example\",\n \"description\": \"description\",\n \"supportUrl\": \"https://example.com\",\n \"documentationUrl\": \"https://example.com\",\n \"supportedPlatforms\" : [ { \"kind\": \"meshPlatformType\", \"name\": \"AZURE\" } ],\n \"useInLandingZonesOnly\": false,\n \"runTransparency\": false,\n \"notificationSubscriberUsernames\": []\n } \n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionPostV1"
},
"examples": {
"meshBuildingBlockDefinitionPostV1": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\",\n \"ownedByWorkspace\" : \"my-workspace\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"BB definition example\",\n \"symbol\" : \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAxAAAAJpCAYAAAA9o9RAAAAACXBIWXMAAC4jAAAuIwF4pT92AAAgAElEQVR4nOzdPW8kV7bu+R2ZyUy+1Vt3o+cAF1MtQ8aMpRqTliRrxtBAZYyvupgP0PUNVP0JbrU3XpfGGu+qgQLGpHQdmUfyrlHAkQQMoBakqmS9kEySGTF4InewslhkMjJzR8TaEf/fvQSlPt1kMpLJ3E/stdZOsixzAAAAAFBGj6sEAAAAoCwCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEobcKkAAIjP3v74nnPutn/g8/+8rLFz7nv/vxl/9+nt7/l1ALBIkmUZFwgAAGP29se3fTAowsEn/vNHNT3SH+bCRfH5RwIGAAIEAAANmNtB+MA59z855/7N/7MCwq7xKgGFix99qPhGn7/79PbYwOMCUAMCBAAAFZnbRfjEh4MP/L/fauE1/8mHiSJQsFMBtBQBAgCAQPyuwif+Q//8lw5f2wPn3NdFqPju09s/GnhMAAIgQAAAsCK/w3Dff3zS0p2FUH7wgeJrdieAuBEgAABYwt7++AMfGB7U2NDcNj/5MPGEMAHEhwABAEAJe/vjBz44fM71Cko7E098mKARG4gAAQIAgCv43QYFh4eUJ9XiKx8kvunAzwpEiwABAMAFPjg8cs59wbVphEqcHn336e0nHfzZAfMIEAAAeAQHczTJ6bE+KG8C7CBAAAA6z09TUpnSl12/FkYRJABDCBAAgE7b2x/f94vTLp/ZEAuCBGAAAQIA0El+1+FJ41OVes5lSXLl/zlJM+dCvVUnzmW9d79XonVAGujr14ceCaBBBAgAQOfs7Y8/8eGhvl2HXuKyvv/cm312V+eG9+ntOs1ckvrP02sW/vo+g2QWUPolvlfx9af+81kU64NvfZBgahNQIwIEAKBT9vbH6nX4L3X8zPkCfpCUW8Cv9A3cLEic+QW/wsJGb/Z91/1+xdc+9WHFtq98kPjR+gMF2oAAAQDojL398ZPKJyxpET/sVRcarpK56r7fNHPJifkgceB7Ix4ZeCxAqxEgAACdUHl46CUuHSXO9etMDfVKtBtxkobryaiG+iMefvfp7a8juKRAlAgQAIDWqzQ8JH7HYaO9weEdaeZ6R+ZDhPP9EQoS3xt4LECrECAAAK1WaXjQrsNWr95SJQviCRHO90c8ZOwrEE6PawkAaKu9/XFlp0prxyHd7mB4cH7C0zCaJYSe/x998zyAANiBAAC0kh/Vul/Fz6bwkI24B5ccpTFMaJqn/ogHjH0F1kOAAAC0jj8kTiM9b4X+2TRdKdsiPIhGxybH8Z1C5/sjHjD2FVgNfwEBAG30qIrwkDdMb/LWWcjinTj1sXPuP1Ti5sMmgCWwAwEAaJW9/fEHWhxW8TPl05aGXWx6uFrv9dTqQyvrwDdZP4nj4QLNI0AAAFrDh4f/5pz7H6v4mdKdfjebpq8y9dOY2uEHHyTojwCuQYAAAETPl6Foys6XVf0s9D68L5mk+eFyLfNPHyTojwCuQIAAAERtb3/8wDn3uJKehzlMXrpAZ0Ectmb34aID/zv1mPMjgPcRIAAAUfJjWrXI+6iOx0//w5y4DpJbh8a+PqI/AngXAQIAEBXf56Dg8Hmdj5sA4anv4bgT4WHetz5I0B+BznMECABALOroc1gkGyTdHuGaOZectLLnYRlf+f4IyprQaQQIAIB5dfU5LJT4KUxdo+BwmrnktHO7Dlc58L0Rj2w+PKB6BAgAgFl19zlcRzsQ2onoivyk6ZPUudb2Sq/lJ78b8XXEPwOwEgIEAMCcpvocFtIOhMa49joQINLMJZPMJVPWCCWoP+IBY1/RJQQIAIAZTfc5XKkr4aGBPofJ9NSN+hu1fb8K/d03WtMfgdYjQAAATDDR53CZjoSH5KSZPocWBQjn+yMUIh4beCxAZQgQAIBGWetzuEiHx+kQudbSWNZJc30OLQsQhZ98WRNjX9FKBAgAQCNM9jlc1HMu3W7p5CWVKx2njfc5HJ5N3PZg1OhjqNA/faM1/RFoFQIEAKBWZvscLtHK3Qdj5zm8OjlyN4ZbBh5Jpf7mR7/SH4FW6PCJOACAuvk+h++rCg9pFrYOJ2vZu6TGsvYOp2bCw2l65rJuHC6h3/cf/e8/ED12IAAAlfN9Djp46+Mqv9fRdOK2+uHKYfLm6X4LdiDyPocsH89qyavTQ6dlyM3htqnHVbEffFkT/RGIFgECAFAZ3+eg4PBFHVf5xeSVuzO6EezrRR8gVK40SfOdB4t+OXyR9z90LEAUvvITm+iPQHQIEACA4Ob6HB7WOZb1t+MDd2NjO9hUn2hPnlZwOPWnSBt1PD1xvx+/zJ+vjgYI58e+PqY/ArGhBwIAENSFPofaz3RQWUwwEZ7EnPc5HE1Nhwd5fXpk4FE07pZ/nXxPfwRiwg4EACCIuvocFtEOhM4V+OPmTbfZHwb5mulOPz9MzrxpNjsMLoLQo9GtKjeTju9AXPSt74/43tbDAt5FgAAArKXuPodFigDRT/ruz1u3XS8JsPLvJS7dNrxhb2ws63XSLHP/Onqef3YEiKt85YMEZU0wiQABAFhJU30OixQBQrQDoZ2IEHQWhM6EsCbfcThNXUyTUNX3oP6HAgHiSge+N+KR0ceHDiNAAACW5uu1tbD5i6WrNx8gRBOZQp1ynIeIYc9EOZP6HPIeB9ttDu9R38PByZt3/mMCxLV+cs49YOwrLCFAAABKs9DnsMjFACF/2rwVbCpTXs60meSfG5FmLpnE0edwkZ4XPT8XESBK+9YHCca+onEECADAtSz1OSxyWYBQH4RCxEZvEOz71L4bEVmfw0U6cVrPTXrJmoMAsbS/+/Mj6I9AYwgQAIArWexzWOSyAOEqChEKDzojotIgUZznEFmfw7xF4cERIFZ14EPE4zgfPmJHgAAAXMpqn8MiVwUI50OEeiJCjXe98MVnuxJ9t355k0KDSpQ0llUnSEf8Nq1maY1rvSo8OALEun7w05roj0CtCBAAgHdY73NYZFGAKNwa7rjdja3qHoR2Jvq+T6LnXNZbECoy39eQzj6rKTrG/obLXNYwfRkCRBD/9EGC/gjUggABAMjF0uewSJkAIduDzTxIBDknAu/QboOCw+HZcakLQ4AI6m9+9Cv9EagUAQIAOi62PodFygYI0WFzd0a74SY0Ie93+P34lZtm09IXgwAR3IHfjXjSsp8LhhAgAKDDYuxzWGSZAFFQOZMWsexGrE67Dm/OjtzLk8OlvwYBojLf+kZr+iMQHAECADoo5j6HRVYJEM7vRtwe7VTTYN1yapQeT94steswjwBRua98kKA/AsEQIACgQ9rQ57DIqgGioHImLWgpa7qervOr08O1rrcjQNRFZU2P6Y9AKAQIAOiANvU5LLJugCgQJK4WKjgUCBC1+sn3R3zdoZ8ZFSBAAEDLta3PYZFQAaKgAKGJTduDUUWPOB6HZ5N8slLI6+sIEE351geJ77v542NdBAgAaKm29jksEjpAFNQjsbMxysNEP+kF//pWTbM0Dw1vTicr9zhchwDRqK98kKCsCUshQABAy/hypcdt7XNYpKoAMW+jN8gnN6nhuo2TmzRRSY3RVew2XIYA0bgD32T9uOPXAUsgQABAi+ztjx+1vc9hkToCxDyFCZU3qdRJ/xwrnd+g66bgUOf1cwQIS9Qf8YCxryiDAAEALbC3P77vdx1a3+ewSN0BYp52Izb7I7fR65sPFAoMp+k0v1b6qKo8qQwChDnf+iDB2FdciQABABHb2x/f88GhM30OizQZIC5TBAl9qHeiialOs4CQ+tAw+0gNvfcTIMz6uy9toj8C7yFAAECEfJ/D/+2c+995/t6yFiAuo50KBYrEJW7Yn+1SFP9e0L8v6q9QAFAQKGTu7b+fTM/O/91SULgKAcK0A99k/aTrFwLvIkAAQAT8RKV7/uN/c879Dzxv74shQOBdBIgo/OCDBP0RyBEgAMAgHxiKD8qTSiJAxIcAEZV/+iBBf0THESAAwABfknTff3zS1SlK6yJAxIcAEaW/qfeK/ojuIkAAQIP8KdEKDZ/zPKyPABEfAkS0fvJN1vRHdBABAgBqtrc//sCfEH2fnYawCBDxIUBE71sfJOiP6BACBADUxPc1PKKnoToEiPhotO2fNsnRLfCVDxL0R3QAAQIAKkZwqA8BIk7/aedPXb8EbXHgeyMedf1CtB0BAgAqQnCoHwEiTtqBaOKQPVTmJz+t6WsucTsRIAAgMD9RSadDf8G1rRcBIk63hjtud2Or65ehjb71QeL7rl+Itul1/QIAQEh7++OHzrkfCQ9AeTGcmI2VaPf13/f2x4/9jRW0BDsQABCAf3N80sg41l7issQ510/8v7vZv18hmfr/PM1cks4+l5Y4l/WS2e2nJLn0e+VfM1vx66+JHYg4MYmpEw58k/Xjrl+INiBAAMCa9vbH95xz39Q1kjVTUOgnLuvPhYZ1Tf1iX5/PLrwvKKBs+O/XW+H7ZQot2duvXeHbzu/HL93x9KS6b4BKECA6Rf0RDxj7GjcCBACswR8E94/Kr6EW8cNkFh4CZYYrzS34s0ESLqS4t187OUmdS0M/cOdenhy6V6eH4b8wKkWA6KRvfZBg7GuECBAAsKK9/bEmLH1Z5fXL7/xvJKvd+TcuOfFBIiACRJwIEJ32Nz/6ddz1CxETAgQArGBvf/ykykZp7TRkm73qdxualmaudxxuN0LlSypjQlyiHOPa82V9if/sSpYUFv1B+eeifPD60r5897E3+x5531Hvit3I+a+vrz2ttw9pRQd+WtMT6w8UMwQIAFiSJoo45/5ayXVTk/KoNysd6orMud5RGmSRM82m7pfDF925di3xb9t3XD/p2/5h9NocFP1HFZQSprPFfnKanb8W8u+zEeD7nZcOZtbDxA8+SNAfYRwBAgCWUGnPQy9x6VYHdh0uo50IhYgAb0m/HD5306yCBgtUop/03L9t/8Hsxc1DwyCpN9QXr4MqvqUPEnmfk13/9EGC/gijCBAAUJKftvTvlVyvLocHT3dek8n6C/+Dkzfu9elRoEeFqukAOR0kZ03efzRs72tSE9Hy15vdZeCBP5CT/giDOEgOAErw5zx8Xcm1IjzkZs3i63+d3Y3NEA8HNbH2fKlcKN3u5aWEbX5Nakcl/7tjd0DDLT+k4nu/8wtDCBAAUI7uhP0l+LVKHOFhTjZY/21JtfTRNeR2lJ4nS70Pef+R7UV1WMXNC9urQf3d/cfe/vgbvwsMAyhhAoBr7O2PP3HO7VdxnfIFywbpoRBqtKtOo9ap1LDNzPSlIsh3JThcpB6kw2j6hr7y/RGUNTWIHQgAWMCHh/+3kmuUOMJDRbQo3ewPW/mztYWeH8KDET3f7xEHjc/+0Z/Dg4awAwEAl9jbH3/gnNNM8o+ruj55k+aI+zjzkuM0b+4MQSNdfz0au5T3OXN6SeL+vHXbRPmS+h06HR4KGqf8ZmrjsZT3k9+NqKY/DVciQADAHN8s/aiycx7m6KC4Tp33cJ0KyigOz47di8nrKh4t1nBntOu2B803T+uuezbkNVhIjlLr412v8q1z7gFjX+tDgAAAb29//NCHh1t1XJO8bKLMybVdEPAwuYteTF65w7NJ16+wGduDkbszutH8w+lp98H44XU1izhAFP6uv+H0R1SPAAGg83yfw5NKpiwtQIDwKgwPBZUynaZnlX19lLPRG+SlSxYwwOB9+Q6g7ZOqyzjwIeKx/YcaLwIEgM6qo89hEQJEfYdZqQ9CU5kIEc1ReNDUJfU/WJDu9BmfPC/OHohFfvJlTd/YfYjxIkAA6Jw6+xwW6fQd0FTBIau1XIIQ0Rxr4UHSXcqX5rWgfOkq//SN1vRHBESAANApdfc5LKITb/NDq7okc/k5D8lpM+89ChHPJy/zcyJQD4vhoZOvvQW0C9jUa7JGf9OBoPRHhEGAANAJTfU5XKdLZRT5IXGn1ZcrlUFjdT3MNExfpBOYtwkQTQf6Bhz43YgnXfmBq0KAANBqTfc5XCnxJUxdGOM6zVxPfQ41HXSbZqnrJdcvDjXi9eDkDedEVEC7DbeGOyZGtV6l8yVMNb8ujfnBBwn6I1ZEgADQSlb6HK7SicOrMn8wXM111epxUNlM2f+uzomgLyIcXXud81D2OWhKZw+Qa+h1adRXfmIT/RFLIkAAaB1LfQ6XaX3zdMNlESfpmRsuuXh9eXLo3pwdsRuxphsb2+7mcDuKx9q5k+C7V65UlsqaHtMfsRwCBIDWsNrnMK/tzZtanGiR0mSfgxqkR/2Npf9302zqxpM37nh6UsnjajNdb+069JN4yoK6FCDqGpccuZ98WdPXXb8QZRAgAETPbJ/DJbLNlvY95PXUWeOHUE2z1J2l05UCREEB5NXpIZOaSlCZknod1rneTehMeDDyuozMtz5IfN/1C7EIAQJAtKz3OVymdY2bmR8BeWbjvUSTlfpJL8iCliBxNQWH3Y1N003SV+lEeGjodakA3y8xwCASX/kgQVnTJQgQAKJkvc/hUm0aHZnNlSsZooZojQ4NeUdcAeL16RGlTb5USX0Ose04nGv7+NaGX5erlg8aduB7Ix616YcKgQABICp19zlo0bjZHwb5Wm3pf8jrqU/sjX9UA/S/jp67P4xuVrKIUY/Em9NJPv5Vd1q7QiNZtdOgHYeYehwuk+r112/nAAMLr8uQfy+NUX/EA8a+vkWAABCFpvocfjs+yE/RDSLxB8fFaprNDoMzOv5R5Us6IE7PV9V3QbVQOjqb5J/bOLlJoUELwa3BqLEFodYnScjTq3sa3drCsx8MvS51rop6YlrsWx8kOj/21faQZgCd13Sfg7bkg9X1Zv4jthugkYx/1CjWumhRXSysFSL0e6JAEfPOhH7Ht3z5l4W7yKnLXD/giyVr286DwddlB/qFdAPrP/b2x3/relkTOxAAzLLQ5/D/vfktX1CF2oXIhj2XDeNZyOR3Nk/tj38sdh+kjh2Iq6jMSYuo4sNyoCiazYsPa+VJp+nUbfTCPabYXnuLWHxd6nf9l8Pn7j/t/MnAo6lFp8uaCBAAzPF9DjrY56OmH5sChPxx82awu7J5GZPxdYzVPofLFL0PRSlRkwHiIj0mnXKtMKHPWmQ1ceq1piYpMOizro0+90KWB1VA12zQ6web6tOGAGH5damJZdoF7FCAKHRyN4IAAcAM3+eg4PC5lcdUBAjdnf3z1u0wiy5NglEzp8W1TKoDp+z2OVzm9+OX70xIshQgrqKdirM0Pf/s8hO035Z/6CyLMrsXWlwP5u7SD3uzn3vQ6+W/s8XnGClA6Jpo6lMIUY9vjeB1+cvhi/z3uYMBQn5wzt3vUm8EPRAAGuf7HFSu9KXVZ0NvjCqR0U7E2tLM9Y5SWyEikj6Hiw59I3NstKjv97Wwb9XIy+A0PndnsBUkuOvufTYy9yMuFsnr8jDv/5kaeCSN0W7593v74wddOcm6G2e4AzBLf3Cdcz9aDg8FLVS1TR+EDxEWapi1OOkdTqMLDyoFOjh5beCRoCoqAQv2msucmQMPy4jldannqM4BBoapUe6/+t691iNAAGiE+hz29sffO+f+EdNhcHqj1N22INKGFwhT//0n9pukL1J40IjdNo5Qxbu0CxGqbySK3/XIXpdvzo66vvtw0X/Z2x8/sfWQwqOECUCtLPY5LKuY9qMTj9eWzRY1yalv8hzUUNOk73mcRtXnME+hQSdOEx66Q8+3elvWLmXKnL3ywUKEr0v1qbD7cKkvfGmuSprGBh/f2tiBAFAL/THd2x9rUsV/xBweCgoRwXYiXD70Pl889N74O49pBYsIHTg18d8j0vCgO9G/Ho0bmWSE5szK1d6E+f6Gygdz2Wwsa2yvyyLI40p6n/vGB4nWIUAAqFxMfQ7LUIgIVp9dyIra5/S8jCGv215lXeFrvvPQcDjNF02x9TnMK8qWKJfopsOz47Dlg0fTaoL6EvT6zF/nJ/EdQMhrsZSP2hoiKGECUBlL5zlURdv3GsN5a7gTfq6+diW0wDnNZtUWiXNZL5nd+rnqe/k7mLHuMFxl/qA4dFfQ8sHU5UE9H+86rLmkSX0Ok6zxALMq7TywC1ia3v/UE3E/ksdbCudAAAiuDX0OheIciOvoYK47o938M8JRmYRKV3T3uawYzoHA9VRfr7vcl7kzuhEmRBQUzgc1BImi5ymiaVAXKTwsej129ByIMr767tPbD+w/zHIoYQIQTNv6HJZR1OYHL2nqMC0gdU2XCQ/ohuA9SEXpoPoQjtYoG7zqa6uUsOhxijQ8FD0PvB5X9kWbRryyAwEgCN/n8DimkaxllN2BmKddCJU0cRd8NavsOsxjB6IdFu1AFHY3tvLXWmV6icv6+cl/Lktmn6+lYQWZLydM21FOqNeknosyZUvsQFzrf/nu09vfG3+M1yJAAFhL2/scVgkQhe3Bprs53Hb9hM3esrSDo7n/64xoJUC0Q5kAIXqu/zC6Gb4HaYHsQpDIA0Ok/QzX0fPwfPKy9GuSAHGtn5xz92If70qxLoCVtKnPoSqzqTHH+V1SfRAkrqZyFDWkM9UFy9IC919Hz/MQUVdwbNuQgqso0HPOQ3B/cc6p1DfqciZ2IAAsxY+je9i2kaxXWWcH4iJ2JN6lO5rH05PgwYEdiHYouwMxT0H9xsZ2rbsRbaRSpVUnLbEDUdqn3316+5tIHut72IEAUFpb+xzqUuxIbPaHbmdjM//cRdMszcuUdC04TRohFb9Xt4a7Yac0dYRej0UZISqnXYhPYr3M7EAAyPleBjf3B+0D/yHadfifnXOdW/GG3IG4qJ/03c7GKN+ZaPuuRLHboMWd7ixXiR2IdlhlB2Kefge0G8HvQjkqIzw4eb12qGcHYin/+btPbz+J6PGeYwcC6BgfFBQM7s19sKPQAJXtqHxHH5rcpDumWuy05SyJIjQcnU3yz0CdFEAm0wOCxDXoP2rUI3/IXHTYgQBazPcrfOI/FBQ+5vleTpU7EFfRzsTWYJgveIa9jajqubVoO0lP/eKt2p2Gq7AD0Q7r7kBcpN8J9Uh0tXRwnsK9dgNfnx4HDw7sQCwtyl4IdiCAltnbH9/zgeE+gSFOekNXDXJRh6wdCX3Mdif6ZnYo1MugJkt9NBkYgDKK39EulQ5epNeqQsPxdEL/kR3qLYwuQLADAbSAH6n60IeGv/CchtPEDkQZChFa/Az7g3xBpH8e9PqVLIiKYKCdBS06itBgdQHCDkQ7hN6BuIx2I7YGo/xzWyc3KeirjLCK3YbLsAOxkjuxnQvBDgQQKV+edN8Hh1Ye4oar5Yt4567sLbi4gL5uQX2Wpu8sLiwHBCAUvX6K11ARJvRaiX1nQq/fWf/RyUqjWFE7VQ18HdNlJ0AAkfG7DY98eKD5GZe6WE5EeRGw2HyYKEoGY+lDmu0KTvPXOeVJUbpPgABQibng8AVXGACqU5TpFX1IKhNU/5FKBhUoqioXLEOPq+g/UmBgt7AV7sX2QxAgAOMIDgDQLJX3TafT90oGtUORuCQPFqJwIdqxWHXYQbFbmLnsvPxI/1nRf4RWiq4MmQABGOV7HNTf8CXPEQDYUyz2lznnpOhHoqwQ83Sz8LtPb/8Yy0UhQAAG7e2PVQ/5mIlKwPJ05xawiuCAK6jagAABYHl+1+Fxk+VKWd83Cyb5Pvwl/4XMudT/V9LMrbVW6yUuK76FyonVqDj/9ef+GShLCzQOCwOA6hAgACP8AXBf17brkPiwoEV834eFUoNG3v6XzrPDNHNJ5j9Pr170Z4NE3Yhvv98yXz/1n8+4u4zFuMMLANUiQAAG7O2PdRLlPyp/JMncIn4QcCyhvp4+D/znzOUL/eR0ttjPhsksrKz6LYvQsZHkGxSzr52yO4FL0WgKANUiQAAN29sfq2Tpr1U+inzxvhE4NCyioKLvt1HB9zv/2v08oCQn6XplVGglhYhVp+AAWJ2mRbX1VG+8xV9XoEF7++MnlfY79BKXjmY7Dm2UB4lB3yXH6ax0CvCYiw804ySlB2kV3316+5uYHm/cZ7UDEas0POgu/ajn0u1ea8PDOf2sW71qdjsAAEs5mVJCuKw0yw7iesTsQACN2NsfV3cwnHYdtnqr9xtESoHJZSlN1gDQIO1AYDnTbPpLbJeMHQigZr5hupLD4dTj0MXwUMhDROCfvZ/wZxIAUJ3J9PS/x3Z52YEAaqSTJv05D8GpUTrb7Phi15duqScilEGv76ZTxj3FpjjtN0r6PdaY4+JslOv481hWPZflfELaVaOV/Xksa5/7gk5gjPLyXp8eESAALKS+h1vBL5Gqd7oeHjztwuRrrkALHU3y4Q0xLrHtGuUL+P6y57HMm/0Pzkco+7NY8nK+9JIXQmGklG4AACAASURBVG82IW3xeSzXfP0zzmQBQjienrhplh7HdjEJEEBNfOnSx1V8t7SC0p2Y6e5tqKlMupP9+vSoq5cySjHsPuQjlQdrno9ymeKsF3/+yvyCvwgOa32/ZO6x+6+dj1Jmkw4eI1yXE+v7CwECqMHe/vh2laVLrZ+01KBhL+JSmI4yGyDyM0x66y/il/2efsFf1dfORylzJgs8zl8pT7vbse5wU/MA1ONhJaVLbnY6M96VXFa2sSLdTWOmeTxmz9fI1uPVQnuoscr92a5AC1+yCkX6+cqVRJUTdR9LhyVsh5f26vQwkkf6PgIEUI8HVX2X2k6XjkRelx34LujOxmZ7L1jLKOxZKqHQDmGbg8M7EjebAhcwRHA3Oz48Z+Wo9yHm/joCBFCxvf3xfefcXyr5LgHfqFtBNdmT8MXYWpQyzjUON4fbZh6nJoJlXRurHDhEsAsRn60BO7bX0Un5LyavbD/Ia/COCFTvk6q+Q0Z+eEs9okfV1WDfGd2o5gsjmO3ByPWTvokLqqlonT0dXSFikwDRRbrRwg7E9Z5PXuYhImYECKB696v6DgkNizPTzPWOppePrAxECxkWM3apbOnWcNfE48vDQ9dLC4uJT2ti9y8uWwNj/UcGHZy8acVocF6VQPWqKV9yrtIFcxR8yVK+81DDGMk7o11GFBp1Y2PbxHOjZunOhwcv1HXYHtCDFItd+sUWOjybtGYsOPtMQEX8qdP/V9XXV03DnVuwKDhobORpvWMjVR6jUqbfj1/W901xLd2l3t3Yav5C9fzZC5gJNF5az+2bs6PoSz7azlIJoUUKD7H3PcxjBwKowN7++JFz7nvn3P9a+fUNdGBaLBSYVK7U1Mx5M4tV5FRvbaU/RbsPmL8gYS6GdpZ2BrzmrLM0wMCatoUHxw4EEJafuPS40rKleUm4u3zmpZlLJlmwE6YXyVy2cJb5reGOS7M0f1NAc7Sw/NPmLRtlZQkjlS8K+VrV4lRjL0/Ts2BfE+GohJDdh8vprIeXJ/Ge93AVAgQQwN7++J4PDh/Xdj0rmLluksqVTtK8ZKkuKpXoX7MoLe56EyKaYSo8FCfC412BX7PqQfr1aMxFNka7gOw+vK8Y1arg20YECGANe/vj2z44fFH3dUw32x8ekpP6+xzkLJ26fv/6chRCRDM0leePmzdtjYvkTJZ35D1KgXcLZ+Vqu+7F5HXQr4vVKcD/cZMR1xdpp+z341dumk1tPbCACBDAinyfw0NVtNR9DfPxiG2+46mxrJN6JiutSyGil/RaM1nDOi0iLe084H3qU6riQEfnJzJpBCah3YY/jG5SunRBW0uWLiJAAEuqvc/hEq1t1lS50nFaS5/DIrp7tMyZD+qJ2Oj18/neTIqpjqa86KwHwoNRNZUbsvNng3aDOBvnLQVb7Y61eddhHgECKGnVPocsy1wScMGTN2q2bf3UQJ/DInojWHbSku6M6u643kBo9AxLgUFNmqanX+Wht7vB5nzXoaaXMCGiWQoPnM8xM81SN568bm2vw1UIEMA11u1zSF3m+iEXFi2rtc5rpRsayXqVk3S1U0IVIP68dTvfvtY2NtanO5xarFgvk9CuWdbFDJGXG2aNHGpJiGgG4WFGu806n6QL5UqXIUAAC4Toc9DdCTV94r0L09jCYxHtPqxbhqSJJFuDYV7SpK+H5UWx63BBfqjjRkcShD8FXj9zkxQiFC4J7NUrJp+ZGl7QEIXWg5PXnS5Z5bcAuETIPgeVMKmkhT+6npGFx1VC3c0smn0Pz47zO1QKkignxl4HjXHtxDkQ2dyuYS3fbvGZLM4H9mF/kI/MpAepGvp7pmlLXW+Y1g0h3RiiTJUAAbyjqvMcXp8e59u+QaSR1knUvPBYxTQ/HO446NfUVv9mf5RPadJ2Nwucqyk4aDEY2yJFuw7ZqP27jHmfw0m909FOpuUGGuiEeJUPqgeJXb+wtAuoQRFd1tU+h0UIEEAN5zloUbq7sRlkFyIvk4gsQ9TdYLmqqmpZdSddC2O9Eet3QWGCHYm3Yg0OuV7S3qlohWk2O5Ol4elo19Hvj3b99PpSSRNhfT0qvVWJWJcnLXW9z2ERAgQ6r67zHLTtqTe3EHQXMIo7npEsPJwf3Rp69+EiBQmFiCJIqFyqq3dLtTjR7szOxijqsoh0s4VT0QoGpqOtEgL0+lIP0njyhjvGK9DfqZ3BVudPl6bPYTECBDqr7vMctFDUnbEQTaF6Q88Gmd3D5IyNZS2j7tNttXjWh2aGq8Tt6GzSiV0J7TZsDUZ5yUns8p6Hlp5A3dQp8BdlKz4AhVKdVq6/u9qNoKypnKh3AwOhz6EcAgQ6p6o+hzL0RqbFU4ipTL3j1KVbPVsLmKLPwcDCYxl6Xpp6s9AbteqL9THbBZm0Kkzobuawt5HfEVYvSKsOgWth03QTfQ6LnKXrHcql8ptR/xZB4hoEB/oclkWAQGdU3edQhrZCfz9+mZcyrb2QypzrHaUu3eyZ2ImwtvAoSwsKK/Wt6pG5NRychwk9Nn3oXIqYttH1c8wWbhumdhrOsqkbBFwgZW3KD6n6lGyVG4ZcyBEk3qf3IL0+ux4c6HNYDQECnVBXn0MZWhhq3KC219fmQ4SaOPP5800saAwuPMrSc/F88tLkY9MiXB9FyVsRKPT5NJ2a2V7XIkSPU7sMGqWpz1Z3GXT9BoNuj6F8j+Fyw6Ozk+Bn6BRBoigdVC9S12rcdU31d0UllK3aEVwBfQ6rI0Cg1erucyhLd9ZUcx9qtGu+ADhzsyBRV1lFhH0O87QA/+34IJo3jiJQzNOCWAuhszTNfx7Vi+tzFT+TvncRFrQAKR5PTAsQve622lZGtQaLp8AX9Dt8PJ3kzbxVmC8d1O+FygbbfKK1XrMqn1WpEmcS0ecQAr9FaKUm+xzKKib+hDsfwrnkOHW6YZdt+CBRxTop0j6HebGFh6vMxitePmIx9QcYFsoGC+0iFAd3FYGhLbJ8UXqSL6JCSPQSiHFDIz8F3na5YZ1npqiMRx86vFDlggoT+j2J/e8DoeF96nNQqVLVE/e6gN8otIqFPodlzLbP03zWdrC7oqk/6XkyOx1XjZ75ImedZmuFBpUoqc/B6AnSZbUlPFxHv0/z89u7PMt9nhYPWiyGeL3l09A2ItrNyPxNBuPlhnptamJd3YqegKJvJ7Y+JAWGovdIH10/NXpe0eeg3yvKlcIgQKA1LPU5LEN3urSgVU9E6HrffKGgsxjc7OC5TCFCoaK3uAFUd1bz3QX9b3XydUv+3qpEQf0n6C6VfGkhcWMjwIz7dBaoaysbXFUEp8DPs3II3GV9SPM9SFWVC5ah94pBr3/ee7TR6xMYrqC/+7pxoNc+wiFAIHpW+xyWoTeiX49e5DsRlU2tyd4GChfXQdZr05u86l3Ztoab24UIcjL8JHVZv2/2BRXLKfAF/S1sYvehjMv6kIpSwaIXSZ+LEczrBIwiIIhCgpsrL2Q3sRwmblWLAIFoxdDnsIxixKvudunuKI2eYcymXr2mWQ7v0O9E0HHKOpPF0ks273PI8l2SWMz+Bsa1Q/i2VLDcov6yxWzbeo2aRp9DPfiNRXR8n4PKlf7axmdPd980vvD2aKcVp/U2hdneWESBUrtSQYYYpJnrHU1nZ7I0fbBj5nugIuxVUnlh28tM2D2oDn0O9SJAICp7++OHPjxE1eewLL2JajdCAeL2aDd4b0Tbqa9kPHlDzSsWCjoJLXWud+jPZBk2ECIin472ghOAsQb6HOpHgEAU9vbHnzjnnsTc57AKvaH+cvg8P/BndlooQWIRal6xLIUI3RUONtq1gTNZYj0FvqA7xpSbYBX8zW8OAQKm7e2PP/DBoRV9DqvSm6s+CBKX400E6yhKZ4JMZnIXzmQZVHdKfF6mdBrnKfAFlZFZbZqGXfQ5NI8AAZPa3uewqvkgoTumXa+n1ba1Fh80SGNdWoxoik6wgx2dDxLakTiZncOSFWey9FdME3OT1PLwEHmZt8qWWABiGfQ52EGAgDld6XNYRxEkNLljOz9pdLMzU5sUFhQcZofw8QaCcPQ7pZ2IP4xuhn896cyIk+ztRoQCRc8f8HjJuSxJNgsgTr/jCiItOo9Fr9vnk5fsGGIp9DnYQoCAGV3tc1jHbJLMbJqMGq63BqNgp+xaou3qozw0TNhtQKW0qP3X0fM8RFS6w6dAkfcsdOtcFl1fhQfCP8qiRNUmAgQaR59DGGq4LqaYaOGjIKHPsc4X15uFfh6NtOWOE+qkxa1Oh+dMlrC0CGSsMsqiz8E2AgQaQ59DdbT4Lu7WaPGjk0yLMGGxb6I4zfUkPX3nsQNNKs5kUV9E1/uN1qHXs/oduBGAMuhziAMBArXxJ0ff9t/v/3DO/Z/OuU2egWrpD/D87oQoSOhj0Ovl4aLOk1C1mMicDwzTM3eaTllYwCz9bmo3gjNZlqc7yGPOd8AS6HOIBwECwfhSJH184oNCERg+4irbosX7Zb0E/aSfhwp34cRUhYukZJW2Fg3FH/9iZ8H54ADEav5MllvDHcqaFtDrXuVKjGdFWfQ5xIcAgZX4sPCJDwn36F9oBy38p9PZ4p8/5MD7OJPlakXN+vF0QukJSqHPIV4ECJTi+xXu+9DwCZOSAHQZZ7K8pZsNxWhloAz6HOJHgMCV/C6DQsMDypAA4H1FkFD53+7GZj5KuQu7EsVo5denx9SrYyn0ObQDAQLvmNtpeEhoAIBytBjSeSz6KMYoty1MKDRot0HBgcZoLIs+h3YhQCDnD3HTTsMXXBEAWF0xilhhQgMItgbD81HKsdHPofHKGmfLIY5YBX0O7USA6Li9/XGx20ATNDBHd5RVlgKsI594dvJ24a0QUZzJUoxQtoLzWBASfQ7tRoDoKB8cHtMMDVxOi6ftAQECYV1cmBdnsChUaFTy7HyWfqWlT7ojfJafvzIbuazHc5am1KQjGJW4jSdv+J1qMQJEx/hSpUfsOACL6YA7oGq6M3vV3f75c1nm//nif0dhY/78lXnzwYCQgKppB0ule+xetR8BoiN8c/RjehyAcqj3RtPmz2VxjgUZ7FIQVnCgz6E7CBAd4MuVnjjnbnX9WgAAgHCKU8fpc+gWAkSL+V0HBYfPa/0pE+eyXqK9df/P/j/vzf79PVl++2L2P9XNNv0RSvXPJf8Y9RKXqVQ98Z8Lff/N9LX9l0rS2b/n3yfljx2uxhY8AFyNPoduI0C01N7++J5z7utamqQVErRYHySzz8sOFUneLvZnAcD/s5tb7E8zl5y9XfDn32ej5Pfrvf0vFF8/898gDyln735tAABwOfoc4AgQ7bS3P37g+x0qLVnKBj40DCocQ6jdBe1gKCz4Bf9KIeUyydzPoK99mrnkJA3/MyBKMc7sB9omc9zcsYI+B8wjQLSMDw//qPKnyrSYH/bCLOKXUSz4q/raw8RlG32XHKfly6dKsDTnHd2U9Rf/DiZzZX5rU+i/8O0SX5YILEunXt8a7nDdGkafAy4iQLRI1eFBi5Bss4HgUCcFia2ec5M035EIQXPdEZ/onrf53qOe7z3qlXuxnv+m+yBR9AjlQfqql0FRutj3u4QLQko29w/515zSh4RyivG0HOrYDPoccBVWNi1RaXjQQmHUq7ZUyRj9vK6XuWQS5rapymGoF43LRi+CBUvPB/tBsnABX/7rvduLdN6HdOZmfUJptl7p4nzZoPOBQqWDZyk7FLiSzq/o9wkQdaLPAdchQLSAPxyumvDQS1y6mZS+k9kmKtVyaRJkJ2LYI0DExnIPRF5GGCo0XEclScNZiV++6g/5LYvSwWE/Dyh5YGdTAhfobyc9SfWgzwFlESAit7c//sBPWwpP4WGr5SVL11CvR3I2XXtRszUY5jWkiIPKlyyWTDTWf1So8Ptm+RS3fh4imIoG1I8+ByyDABG/ag6I0833joeHnO6QbvTWns6kBak+ON04Drsbm6YeZ16mNOrATqBeb+qzOg1XPghgMfocsAoCRMT29scPnXMfV/ETpG1vll6C6sFDXAotSl9MXtf2uLEaTc3aHtgJENpxyMuHOiQvH8zWD+4X9ZPecv8DoMXoc8A6CBCR8qdMP6ri0edv3nXUVsci0LXQovTlyWE+VQR23djYtvHYOji8YF4emqZJ0JHKTPIB6HNAGNyOidfDqg6Ky2us8VbAUZN3Rje4sIbpDvXuxpaJB6gSwq6Gh0JezoTO4yydcNTn8K+j54QHrI0diAj53YeHlTzyXqBTnlskCVgWqkkim/1hXnMKe6wEvHzh3MHJZ+/xY19DNVXr9feKao3ocJbO+uhzQGjc3onTg8p2H9jhf5fm1Aeuw9YilVpse7TzYGFUZLbqGQttFTBIsRCNEyNcV6c+h9+OD9zvxy8JDwiKVUycHlT2qNkqfkcVc+m1Hf/HzZtsyxuiBcqt4Y6JB5QfYohK6DVHiIiLdmyxPPU5aGjHr0djmqRRCd6pIuPLlz7q+nWonHYejqqbR69FjJUFa9fpufjD6KaJq5DvPJAr3xV4Jv32YBT066FaOkMHy6HPAXXgVkx87lX6iLPQR83Gp64TcYtRoYx2bc5sN+iGnd0gSpfelbngIV6vOy2wOCzLPr0uN/sEvrLoc0CdCBAR2dsff+Kc+3+qfMTJ+ocuxytVcMiCjo28DiGiOdp5uDPaNTXaMyM/vCM5zSopIVRZzOHZJOwXRnD6+0ip5/U4zwFNIEBEYG9//IFz7rFz7vPKH23q37C79DfbN0rni5UGFCFCbwDcFa2HwsOfNm+xODEs3wkMPMCgcHO4nd+t5fVml16bZs5kMYrzHNAkAoRhc+Nav6zzUeoOfFemwCQnmUtOqy9Xuo5ChBa1s0kZHDRXJd191iQswoNdKiGsMtBr12lnsJWXMsEmPT+8Rq/2+vSIUjw0igBh1N7++IHfdahkXOtVNH++C+Hh/O5mTWt1bTFfN/1F//c/b91xzycv2YquiBrXrRwUd5kkfMVOXKaZ603qeV0WuxB6bcIW/S3U84P36b1BJa/0OaBpBAhjfJ/D4yYmLXUiPKhc6Tittc/B+a3mMnTHTaU13F0Kq+h3MD/CU7+XXWykbuh1qd8JzcjndWaH/gbqecG7tDP9YvKKm0swgwBhRK19DpfINlp+eFXDfQ7L0l1yjS/UnSbeMNajOupY7mbm5YMGHkdtGn5dFuOUGWJgh54Pzup4S+FWN5N0UwmwhFdpw5rqc3hH4lw2bO+RIFqc5OVKDa7MVulrUJ22diNmo/le0xuxJB0OZ23K0nUy1Xx3ZIiBhdel8/1HRTMqmqXwUAyVAH0OsI0A0aCm+hwuau3hVXk9dTabLNWwdI3Fv5p+/237D+7lyaF7c3bEm8k1FBy066DPMcl3AbtwCnUDr8vrepC046f/DqNdm6MD/iz3J9WJPgfEgADRAN/n8Mg597GFx9O60qXMT3Gp6BTpZWnnIMSiX2U4eoPVXSmN7WNH4l2xBgfJ+h0ID8ZelxfNJnP1KBVpgMKDrn/X0eeAmBAgauT7HBQcvljnu56kp27YC7hI6rUkQGRzZRGGHAW8q6kGQwUJfShEvD497vwUGS0+VPYQY3DIJbMBBq1l4HVZNsDP6u/79ETUSGWGXS9bos8BMSJA1GCuz+FhiHKlk+lZ2ADRAvlY1knz9dSXUVmEypBC05uuPhQg9MbTpYOx+knvvNE8ph6Hy2Qbvdb2PNQ9Lvkyy74m9JrS75TGKVMuWJ3ZtKUblfxtjAl9DogVAaJivs9Buw5/CfWdtFDcGozyRVQQqkXuR7qCmWazw+BqHv9Ylhb3+qjyTXI2onS2/a/fDe14tDFM6Pd9K99tGLVqSot6H1rH0OtSO7bJkglNu1l/3rrtfj9+1fkdviro9fvHzRvRh/910OeA2BEgKlJ1n4MaakPNytZdwiy2ABHJWFaVGNVJQaUIKwoRepNSoIi1X0ILOe22aaehlaMdey2buGTwdanXwCoBXotbhQj9reXE6nBiGqtcBfoc0BYEiMBC9TlcR/Xv+iMcYhcinz0fy+jIop761Ga50jy9Qeh5akoRJlTXrbtcejz6OE2nZu+qFoFh2B/kn1XmYI0WAKF2/zKDP9+q8h0Hg6/Lo7OTtXYA9XdWAVZjXln0rU6v7S6f8UCfA9qGABFI6D6HMnQXQ+cErC2dLcqzoe3FjIV66mVYmiuvu6nbg/47zYqzMHGWL4j1+Syd1rZToUWEwoFCwqDXy/89loWFQqHuomLG8utSv+MhSkT0u6m/tXrutSPBBLTyFLYVwrrcKE2fA9qIABFAFX0OZejNUX+YQszOzhcAvZ7Nka6pGqTt9jlcRm8W1mundUfwsslFetx6o9PC6yydLZR0PvKyP898o3/xfRQWYq97fnM6CRYgoj55OoLXZehzHbQI3uyP8r+7nMmymG4Q7Ay28vcnizuJdaDPAW1GgFiDhfMctFDV4izE3dvkOHVu01CIiKTP4SIttHWXMlZvf5eY9HUZLQa0MFUzdwh5D1JMZ7FE8rqcHQwXvoSwGKXMmSyXIzjQ54BuIECsoK4+hzJ0B0yTQtTsF+KPdR4ihr3Gy5ms1lNfR8/Hb8cHth8k1nZw8jqvqw+yQNJCPJIAcX6eQwSvy6pLCDmT5V268bC7sdnpUiX6HLCGcWwXjwCxhCb6HMrQHVEtWlWjGyRE6O7iWeLSUVL/eNdp5nqTePoc5hXhgbKG9isWCmoKXVdeAqQeJMvjXCN7XRYTyOoyfyaLdqcUKLrwd0DvNwrS2m3oanN0gT4HrOmb2C4gAaKkpvocytIbV8gQofrm3tFsvGu+G1F1kMhmux8x9TnMK8IDM+O7QwsGlQ+GOOMjPwQxMdiDFOHrsigfaYIW0beGgzxYtvVMliI06EyWrh8C5+hzQCA/f/bh97FdSwLENSz0OZQVPET4u6PJUZbPq9eJufkCJ+AaR/XfTlNczuJ9gyU8dJcWqn/euhNmnLKlHqRI+4/k92MbJ0jPn8mivw0aJ6swEePfCQWjIixfNnihi+hzQNcRIK5gqc9hGUWI0CFzQbeU09ld0mQyO/wqP3hOuxO9/JZUua+R+cktU/854tBQ0PVWDwp3n7pp1oP0Mlz5oELEhnb9eo2dy5KPZZ3E13/k8kD32uQCPR9TPBy4m247/53R6dgn07P8czH1zJIYzmNpCn0OqMC3MV5UAsQFVvsclvE2RNyoZotZYSKd1W2fv630EpcteI+JtTRpEdU6q5mWmtduC73zlzcqT6d5iKh1NyLvc8jycB8jhYcmD24sqygBmv/brBsQOuBRoUL/XJzNUvXfFgWFxCV5wFFY2Oj1ox+zXCX6HFCR6MqXHAHiXdb7HJZR3BlVc5tm1ld+BynNojjIOgRdW014iWGxgnqE70HyvQcVlQ6++72y2dSziHcEYwkPV9Givd/vX3rDZz5IXCyXuep8FpXUXQwCRemRfj+73vC8LPocULHoGqgdAWImpj6HZemOif74qamP2tX18UaCq1TRgzRfOpiHiEEyKx9c98tnvlTpNN4dh0Ls4eE684t9/obXiz4H1IQAEZtY+xyWVSxsatuNaCF2HVCGXmu/Ho3dHzdvBL/Lez5wwM31ISUKFL4P6bKXddF3lM3CSP7PCgwtOPdMr8nnk5cs7hCcfrd00njMB4IiGl/9/NmH0Z0B4boaINrQ57CK4tRUhQiFCZRTNMxR94oyinNZbg13g51W/Z6iD8l1p3RwHsMLUBV621CzJ7Fe8M4FiDb1OayiuJOuU1N1gmplC5wW0BuJ7kCxSMGy9DpT6YPOAdAwA3b9wlGg584wQtNOlt4bGceNGn3782cfRlm+5LoUINrc57AKLYq1wNEb8e7G7BRVFjlvt67fnE4IDlib5v7/6+h5dRPROkQLO6tjWhEv9TmMJ6/z1ypQs0cxX/DWB4iu9DmsSotk3XXRXb3N/igPE12c0KFFiXZljqcTtq4RVDERTQ2wChIhDp3rEubuowr0OaBh/4x598G1PUDs7Y8fda3PYVX6Y6r+CH0oQKi0aWswavViR3eeVGKiUiXuaqJqKpH45fB5vtun8kGCxPWYu48q0OeAhh045x7E/iS0MkD4cqUnXe1zWJcW0wcnZ/nORNvCBKEBTSuCOkHiclrUqZyE/iOERp8DjHgQ6+Slea0LEHv748fOub8aeCitMB8mdDDR1mCYl2IMextR9ExoMXKSnuZvHEdnJyxIYMZ8kOhq6eA8hXtdDyaeITT6HGDI337+7MOv2/CEtOYda29/fM/vOnxk4OG0khbfenMvapEVKBQmNnr9fPGjjyZDhRYdCjyzj2keGggMsG6+dFDjldVs3aWBBlrUKdxzxgpCo88BxujMh6gbp+e1IkDs7Y/v+/BAr0ONtDg/PHt3ga6Fz3yY0OfEJW7Q6wcp1dCdpLN06jI3CwvzoYG7lojZbMrQq/wn0K6EdvvaOrlJP6vKCNkVRFXoc4AxCg/R9z3Miz5A+HMd/mHgocDf8dGd/+tOh9XORVmcNIuuKXYlFMJVLqgeJL1mYu6X0E4DpYSoGn0OMKh14cHFHiAID/EiFADXKxqKi9pt7egpSMxKBwdmA0WxM1j0H/F6R9Xoc4BRrQwPLuYAQXgA0DVFuV7Rh1SUCc4HirqbsYuyQoWFszQ9f4xAHehzgGH/+efPPnzS1icoygBBeACAq0sGNeBg0Ovl/UfD/uzPfNGPVLhu6MHFr6mA4OZ2F4rPQFPoc4BRPznn7v/82Yfft/kJii5A+GlLjw08FAAwST0G0+msz4CSDrQNfQ4w7O/OuUdtOOfhOlEFiL398W3n3NdMW0JsaBoFgPXQ5wDDfvIHxH3TlScpth2IR5wujRjxhgcAq6HPAYYd+B2HzlXGRBMg9vbHn3DCNGJV1It3/bRhAFgGfQ4wrDPlSpeJaTXTmtP70E3afi9/+gUAdBd9DjDsW+fcw7Y3SV8nigDhdx8+NvBQIoVjnwAAIABJREFUgJWdTM9ae7IwYNmsB4n4HgP6HGDYTz44qBe382LZgWD3AQCwEp1+vT3Y5OIZRp8DDFOfw+OfP/uQtegc8wFib3/8AbsPAIBVUQZjG30OMOwrv+vQyT6HRWLYgbhv4DGYMn8YFABgMZXFwB76HGAYfQ7XIEBESJN8qA8FgPKYgmYHfQ4wjD6HkmL4a0r50gW9hB2IGA37kS5eEueyXuJcT/88+5wt+BVMVIVQ3PCdZi5RWcIyN4B7xfdL/Pe+5HsU5/Kt8vXRSZTHNK/oc3h9esTzAWvoc1iS6RXN3v74noGHYQ530eK00evH8bi1aB8kzvUTl/Vni/hlZBe+WP7veajI8oV/cpbl/zwv/36D8t8vO7+Ub79+Ms2cO8tmXx+AKepzUIM0p/LDIPocVmB9JXrbwGMwZ9RnHGFs+knP9RPDAWI+NAwq2OFKnA8kzmXDZLbg10Jf/39j+ZBy2dc/DyH62ifp+dcH0Bz1Obw6Pcw/A8bQ57AG6wHiEwOPwSSdJ0D9aDzMhj6VC230ZovvOivjEh8cqvrao57Lhs4lkzT4joR2AGn6jA87t/VSn4N2HA7Pjrv0YyMO9DkEwF/USG0NCBAxMTeDPvHBIcTdf6v0M272nDvN8iARCj1I8dFzxvNWD/ocYBh9DgERICKlBemsnpTuUetUvmRpB0J9BvnCuiPrqVlI6rnkOMxrZdjboBwjMuw+1IM+BxhGn0Ng/FWN2M3htnsxed31y2CenicrsmFv1oPQMXmJ1qgXZCdCu3+q6UY8VPKJ6tDnAMPoc6iI6QAxzdJfdfcWl2MXwj7d+bRSvqRdh0oapCOR70ScJbNpTWvQc6q/S7zu4qHQh/Doc4Bh9DlUzHSAODqbDHc3tgw8Ertuj3bd78cvu34ZzLo13DHx0PKm4g6Hh4J2X5Kj9euyFQrZhYjDLPBFMkI5EvQ5wDD6HGpi+vb+0dnkmYGHYZq25rcHo65fBpMUfi30Pig4VDbxKDb9JMhfvZ0NXnOx2N0wNsAgcupz+PVonO88EB5gjPocPiA81MP0DsRJevZaW6SUMS12a7jrTtMpoyUN0V1PE7sPfqQp3sqSpDh+bmW6o63grsUU7NJ7h7kJaJGizwGG0efQAPNN1PpjxR32xTSe8M5o1/12fMAdIQP0fPxx84aJx1L7+Q4RSAK9RBTcNUqZ15xdd0Y2Xocxo88BhtHn0CDzAeLobEKAKEF3vP+0eYsQ0TCFBz0PVmquKV26IMsLuIN8KT3XNza23cHJm4APEKGovJNT+1dHnwMMo8/BAPMB4iQ9zf94cQjQ9QgRzSrCg6mZ8z1eN/OS07CvC/W5aBeCsg5bZruy7D6sivMcYBjnORhhPkBoIaw3aHYhyiFENMNieNCBcZgzzVxyEn706h9GN92vRy8Y62qInhNuOi2PPgcYRp+DMVEcJKctVAJEeUWI0HhXFjXV0/VWDwqn3dqVnGVBDpG7zKzn5Sah3Qi9FildWg59DjCMPgejoljxaLqQ7ojwplCeFrN/3rrjnk9ecjepQqqzVqmExbudSZatOWuoBTKX7zqELl26iJ0/GzT5jKlL5dHnAMPoczAumvmOHNq0vKKsxsphZm2j66o7z2ZLJVLfNNxRCg29w2nl4aFQhAhKZ5qhhnYOHi2P8xxgmPoc7hEebIum5kJ30Q+ZyLSS4kCzF5PXnBURQEwlS8k0694J1NPM9SZZsGlLy2Anohl6PbLzUA59DjBMfQ6Pfv7sw294kuyLqmj74OR1XjLCHb7lzUqabudb1XrzYHGzvGJsZ0x3OZOTDgUIlStN0rzfoUnFa+3341cE9ooV05b0voDF6HOAYT/54PCEJykeUQUILXo1c113m7AaLX51p05hjFN0y9N1U3iIKrz2EpdudeAU6mxWrlTFhKXLlBkrrXNAtBPB66w6DC8ohz4HGJb3OfheB8ayRia6v7y6e7I1GHLHaQ3FXbubw21/R4oFzlVUMqfrZOVguNKK8NDyzYfz6Uo1ros0G7+XXP+ns3idbQ1G7sXkFYu3gKIM9A3gPAcY9pXfdfiRJylOUd660ZuxuQO7IqRF8XyQ0HkbLHJmCz8F1CiDgySu/eEhP9Mhy3s8rNPvkkqaxpM3+WsMq+snvfxvFhP5FlPpnHbr6XOAQfQ5tESUK3AtctUQzMSTMIogoeuqHR5tdXfx/AgtTooSr5h/r7JRi8NDTWNZFz+E5b+3XmOa2KUAMZ685nyWJen1uDPYykM9rlaU+dLnAIPoc2iZaG/h6w6LzjhQiEAYepPWAlofur4KEm3flSh2G/Qzt2JHK3GtbZrOdxxO6y1XusxZmrrhiq0l+l37t+0/MMxgCdGWEdZMv0/0OcAg+hxaKuoVk7ZntRNBU3V4swbFG/nXVYg4Opvk17sNd06106ASCNWmN91Lk2ap6yXhGp3bGB7yPgc1SBv51ZtNVlpvnHSx06UFnxpcWfS9j+BQzmxX6w19DrCIPocWi/6Wa7FVS4iojhbZxUK7OBVcHyfpaRQLH+0yDHsbeWjQh6WdhtlEn4BfsE0lfakapG31Oej5CjWaVb+XWiDrQ3/HZs2u3S5tKkqVdjZGBIdr0OcAw+hz6IBWdCETIuqjxbc+irMQ9CY2+5ieh4umFSFho9c/f7xWacE4cCyU3mGgz+EqVTVBazdCH7MDM487NxlNr1ntOHAY3PXoc4Bh9Dl0SGvGGOmPqcpBVHZDY3V9LlugaytddeJFmNBOhfNhI8SOhZ7f4ntqZ8H5Bcig14vyriUnrL91fp6D0Y0tlRxV+fel2CW7Ndx1x9OJOzo7ae3kJr2G9XuvsdzsNpRDnwOMos+hg1o1B1VvtL8dHzCdqWFaDPT7/YWjFpcNE/OhoW1UuhIqQKhfIBtG+Ls/zVxvYqfP4TIKxPq9rWOEqH7fi10JvU4UJvT9Yx9qoGunckhCw3Loc4Bh9Dl0VOtWZHqD/9fRc86JMI7n5i0tCoLtQqTZ7CNoY0WFVK50nEZxnoPu/jZhPky4yPqQFBi0SzjsDzj8cwX0OcAw+hw6rpWrOL2h/no0dreGO+e1+oBl2oXQAivEzpkaj7Mt4wHCcJ/DZQ79FDILLvYhKYCqB+lkenYeKEI1epdV7BDG0ntkHX0OMIw+B+Ra/Re+uHNDXwSs0yJQd7gVeteV380/sVvKlI9lndjtc7hotph7betBzSlKBi/e4S/KBIvP+n/zweIsnV479eli6aBGIBelR0UpF6dCh0WfA4yizwHvaP0tItWOqqTpD6ObvNHBNC0aihrxdeWNyL2erXMh8j4HX2IVER1YGeNirlj483cvDvQ5wDD6HPCeTuwx681fzdWqIdYdXnYjYNWLyatg/TvqLXAbictG4Q6qW4nKlSZpvvMQG+rPUTX6HGAYfQ64UqeKVFVPqmkmGpHI2ExYVITdP2/dyctF1pWPRZ2mLh0lqj+p9yfO5sayRkh9D9oVAqpAnwMMo88B1+pcl5v+aOsur/5o39jYZnsf5uh39Pfjl+HGEaeZ6x1lLusns76IGoJE3udwYnss6yIKD/o7AVSBPgcYRZ8DSuvsmIzZGMRZWdPN4XaQu71AKCpr0E6ETlcPNc1GzdXJ0WzEa6bSJvVHhMwSmf8eEQcHR3hAhehzgGH0OWApnZ+zV5Q1aSSidiQAK4oQEfxMkzTLR70mEzcLE4PEZf3ZPy8dKBQYpsXn+O+mqqSEsiWERp8DDKPPASvpfIBwvmREc/jfnE7c7dEOBx7BjOJME40irqRvR2HiJHubG3rOZSqb0obcZeVTKrlInUv857YoSht1hxgI9/KizwFmqVzpIX0OWBUBYo62lVV7rr4ITWviICRYocWt7l5WPkVM4UC1SHmFRTfqs3V3+PfjV5SVICj6HGDY3+hzwLpYIV9CCzXd9WXsKyzRXczZwYi7NP8HokWedh+BUOhzgGH/9LsO9DlgbQSIBYr+CPVGqEcCaJoWJZxpsj4FsReT1yzyEAx9DjDsBx8c6HNAMASIaxQ1rK9Pj7nzCzNo/l/NNEvdePKaXgcEQ58DDKPPAZUhQJRU3PlVgFBDK2Nf0bT55n+NIuZwxKspOOhaschDSPQ5wDD6HFApAsSStD39y+Hz8zu/lJCgaQq3arLWAnl3YzMvb+L3cobggCpQAgfD6HNALQgQK9JdJy1Kbg13ufMLE7SYUSmF7ooqRCjkdnWnTCVKb06PKVVCUAqkxUQ0wBj6HFArAsQaitnxChNqaKU/Ahbo91K/k/rQ76TChM42afuuhBZ3+pmPzk64M4yg9JoqypUAY+hzQCMIEAEUJwZrkXZ7tEt/BMzQndLibql+P7cGo1aFCb329PMdnk3yfwZCU2hQeKDPAQbR54DGECACUrmE+iPU0Loz2KIOHabo97Mo6dEhiVuDoRv2NqLaOdMi7iQ9zXcZFBzYaUBV6HOAYfQ5oHEEiAowGQfW6W796cnbO/YKEQoVxWcru2haxOWPNZ0SGFAL+hxgGH0OMIMAUZFiMo4arTWtif4IWFaUOs3XeOt3tp/03aDXy0NF4pL8c+idNQUE7Sxo4abXzcn0LP9nSpJQJ/ocYBh9DjCHAFGx2cKMk4MRn9kd2Kvvwl4MxYtC8lmavrN7oMUaAQFW0OcAw+hzgEkEiJpwcjDa5mKJByUfiA19DjCMPgeYRoCo0fzJwbdHO/k0HABAvehzgGH0OSAKBIgG6G7X78cv85IPlTWprhwAUC36HGAYfQ6ICivXBunu169H4/OyJvojAKAa9DnAMPocEB0ChAF6YyumNSlMALDrLKVePib0OcAw+hwQLQKEEbordnDyxr0+PXZ3RruMfQWMKkbMUnpoG30OMIw+B0SPd0BjdJfst+ODPEDcGd0wc6AXgLe0KCVA2ESfAwyjzwGtwTugUVqg/HL4PD/NemewRX8EYAhnWNhEnwMMo88BrUKAME5jX/WmeGu467YHo65fDsAElcfADvocYBh9DmglAkQEdDdNtbyzILFDfwTQMO5w20CfAwz7yTn3gD4HtBUBIiIqm1B/xPZgMy9toj8CaAYlTM2izwGGqc/h0c+fffiYJwltRoCIkEa+Hk8n+chX+iOA+hHem0OfAwz7uw8P9Dmg9QgQkdKbp/oj3pxO8t0I+iOA+gx6fa52zehzgGHf+nIl+hzQGQSIyOnNVDXA2pVQfwSjJeMy6HEnG1iEPgcYRp8DOovVZkvozfXXo3HeH6EgQVlTHPpJP3+uKMeIy7DHIIOq0ecAw+hzQOcRIFpmvj/ixsZ21y9HFLQYPZ6edP0yRIVJaNU6PJu4g5PXBGtYRJ8DOs8RINppvj/i9mjHbfaHXb8kpm0NhgSIiGjHiABRDe2kHpy8YcoVLKLPAZhDgGgx9Uf8fvwyX+zcGd1gcoxRm301wL/u+mWIBoE8PPU5jCevCdKwiD4H4BIEiA7QXb1fDp+flzXRH2GLng9N0VLZBuxTnxHC0G7pm7OjfMcUMIY+B2ABAkSHqBlRPRIKEQoTsEPPBwHCPu3mUb4UBn0OMIw+B+AaBIiO0Zu1aoxfnx67O6NdFkNGaPwuuxD2MZhgffQ5wDD6HICSCBAdpf6I344P8nru26Nd+iMM0IGAqgHnjqxNeq0QuFdHnwMMo88BWBIBouP0Zq7+CC1edwZb9Ec0SGdC6A637s7CFr0uNIgAy6PPAYbR5wCsiACBnN7c1SNxa7ibl9KgGeqFUIkHd2ltUXggXC+PPgcYRp8DsAYCBM7pTf7F5NV5ozXlGs3QYlXlZdSI26DXAqNbl0OfAwyjzwEIgACB9+jNfzI9yMdVqrSJ/oh66U73nzZvuX8dPefObcO0G6fXAMqhzwGG0ecABESAwJW0E3E8neRlNfRH1KsIEdqJIEQ0Q+GBvody6HOAYfQ5ABXg1jIW0sJAi4Jfj8bcVayZRrsqRLADVD/CQ3nqc9BuGeEBBqnP4QPCAxAeOxAoRWNffz9+mfdF3Bru5ItbVE/X+c9bd+iJqJF6Hihbuh59DjCMPgegYqwCsRQtGrQbof4IBQnKmqpXlDNpmg0HzVVH11m/0/rdxtXoc4Bh9DkANSFAYCXz/RGczlu94hwC7QDpri99EWFpp0cns7OzdjX6HGAYfQ5AzXi3xMqK/og3p5N88cXY1+rp7riu84vJ63w3COujZOl6nOcAwzjPAWgAAQJrU3+EavS1sNVdcpp+q6UTq1XSpIP/Xp0esqhbEf0816PPAYapz+Hhz599+D1PElA/3jkRjBYbvxw+Py9roj+iWrrO2pFQiFCYQDkKuNpxoNfhavQ5wLCffHD4micJaA4BAsFpMVucZq1FLqpTNP7ubmzm5WQ0WV9N10rnmeh3knB7OfocYJj6HB7//NmHj3iSgOYRIFAJLURU+qAFrRa49EdUS2VNKh/TnXWCxLu041Ds1hAcrkafAwz7yu860OcAGEGAQKVUO63+iM3+0N0e7dIfUbEiSNwa7p7vBKkcpYsUWnUgHKVKi9HnAMPocwCMIkCgFqqlVn+E7pCrjIQ7wdXS9dW11oeu/dHZJP/c9rvLCqhbg1Fe0qUwhavR5wDD6HMAjCNAoFbF2NdZE+uIi18D7f7ow/kg17YwUYQG/T4xUel6RZ+DdqgoV4Ix9DkAkeDdFrXT2NcXk1fnjdb0R9RnPkyodEUfChMxla9od2XY28h/b7YGQ3YalqA+B4V4vQYBY+hzACJCgEBjZgvYg7xGXTsS9EfUSwtwfdx0s0PUikChMKEPK70T2lXY6PXzz3q87DIsT8+rxv1y+CAMos8BiJD1d+J7Bh4DKqadiOPp5Pz8CDSjCBQFlbcUYUL/fJLOFp9VLEK1q6BgkLjZ50Gvl+8ssDu1HoXA2VSu45h/DLQTfQ5AxKwHiE8MPAbUQAvUoj/i9mjnvMwGzdGi/mKomKcymLP07S5FETQWKYJBQWGBhvrw6HOAYfQ5AC1AgIApWpT+fvwyX7Tq/AjKVexSEOj334YBdgtsoM8BhtHnALREkhm9O3X36TOVL/27gYeCBqk/QkGCu9TAYvQ5wDD6HICWsXx797aBx4CGFf0R6o1QjwSAd9HnAMPocwBaynKAoHwJOdVw66Tc16fH7s5ol1IZgD4H2EafA9ByFJgjGqrp/u34IA8Qd0Y3GPuKzqLPAYbR5wB0AAEC0VGN9y+Hz8/HvtIfga6gzwGG0ecAdAgBAtFS6Ybqvm8Nd932YMQTidaizwGG0ecAdJDlAMH2J66l2u8Xk1d5mNC0Jvoj0Cb0OcAw+hyADrMcINgGRWk6xEz9ETqA7vZol/4IRI8+BxhGnwPQcZYDxI8GHgMiczw9cb8evcj7I3YGW/RHIDr0OcAw+hwA5MweJOdmh8np7sYtAw8FEdJJyTeH2/RHIAr0OcAw+hwAvMN6E/U3zrnPDTwOREilH+qP0IJM05roj4BF9DnAMPocAFzKeqE4dzuwNpWCqD/ixeQ1CzSYoj6HX4/G+c4Dv5swRn0O9wgPAC4Tww4EEIR2Io6nk/PzI4Cm0OcAw9Tn8Ojnzz7k/RfAlUz3QLhZH8TXlDEhNPVH3B7t5FObgLrQ5wDDfvLB4QlPEoDrxDDrkj9mCE79Eb8fv8xLmzQCFqiSypO046AJYYQHGKM+h7/5ciXebwGUYn4Hws12ITTS9S8GHgpaqihrYuwrQuM8Bxj2ld91YGw6gKVY74EoqInrHzYeCtpIE3CKaU0KE8C6tLN1cPKGPgdYRJ8DgLVEsQPhZrsQ+kP3sYGHgpZTf8Sd0S5jX7ESlSspOFCqBIPocwAQRCw7EPLQOffvBh4HWk6lJuqNUIP17dGu6ycxtArBAvU5cJ4DDMrPc/BnOox5ggCsK5odCDfbhVAp05cGHgo6RKdZ7wy26I/AlY6nJ248eUOfAyyizwFAcFEFCDcLEd875z4y8FDQIQoPt4a7bnsw4mnHOfocYBh9DgAqE1MJU+GBP2Dulo2Hgy5QScqLyau8POXWcIf+iI6jzwGG0ecAoHLR7UC42S7EfefcfzXwUNBR24PNvLSJ/ojuoc8BRtHnAKA2UQYINwsRDxjtiiaprEkjX+mP6Ab6HGAYfQ4AahVtgHCzEKEt2i8MPBR0mMa+ajeC/oh2os8BhtHnAKARUQcIR4iAIeqLUH/ERi/G1iJcRJ8DDKPPAUCjog8QjhABY9QfoSBBWVO86HOAUfQ5ADChFQHCcUYEjCn6I25sbPPURIQ+BxhGnwMAM1oTIByN1TBI/RG3Rzv5qdawiz4HGEafAwBzWhUg3CxE3OOcCFij/og7oxuMfTWGPgcYRp8DALNaFyDcLER84Jz7mhOrYQ39EXbQ5wCj6HMAYF4rA0Th7tNn+iP8VxuPBpjh/Ihm0ecAw+hzABCFVgcINwsRnzjntAX8FwMPBzhHkKgXfQ4wjD4HAFFpfYBwsxBxW3+c2Y2ARQoPm/1RfhgdPRLh0ecAw+hzABClTgSIgt+NeExvBKzStKadjU2mNgWg4PDm7Ig+B1j1N/ocAMSqUwGicPfps4d+R4JJTTBJ4193NkZ50zW7EsshOMC4fzrnHtLnACBmnQwQjrImREQjYBUktCtBr8TVplmahwaVKhEcYNAPPjjQ5wAgep0NEAU/8lX1px/beETA1RQitgYjwsScw7NJHhpojoZRBz440OcAoDU6HyAKTGtCbDZ6A7c9GOU7FPrnLtEo1qOzE3c8nbDbAMvocwDQSgSIC+4+faaypof0RyAm2o0Y9jbyMNHGQKHyJO0wHJ1N3El6SmiAdfQ5AGg1AsQlfH+EpjV9Ye7BASUoUChEFGFCHzE1Y+vMhtN0mocGfXDoGyJBnwOATiBALHD36bN7PkjQH4HoFaGiCBP6POj1Gw0W2kmYhYWzfJdBn+llQITocwDQKQSIEu4+fXbfBwn6I9BKGhs76PVc4hI37M/Kn/SfzYeLZcKGwsBZ+nbXQMEgc9l5YBCCAlqCPgcAnUOAKMmXNT2kPwIAQJ8DgC4jQCzJj319RH8EAHQSfQ4AOo8AsSI/9lVlTR9F+QMAAJZBnwMAeASINd19+uyBDxKUNQFAO9HnAABzCBABzPVHfBn9DwMAKNDnAACXIEAE5PsjtBvxeWt+KADoHvocAGABAkQFfH/EE8a+AkBU6HMAgBIIEBW6+/TZQz+xif4IALCNPgcAKIkAUTHfH6EQ8ddW/6AAECf6HABgSQSImvj+CG2Lf9yJHxgAbKPPAQBWRICo2d2nz+77Rmv6IwCgfvQ5AMCaCBANufv02SM/+pX+CACoB30OABAAAaJBvj9CuxFfdPYiAED16HMAgIAIEAbcffrsng8S9EcAQDj0OQBABQgQhtx9+uyBn9hEfwQArE59Do9+/uzDx1xDAAiPAGGML2t6SH8EAKzk7z480OcAABUhQBjlx77q7tnnXb8WAFDCt865B/Q5AED1CBDG3X367BMfJD7q+rUAgEv85IMDfQ4AUBMCRCR8f8RjypoAIEefAwA0pMeFj4M/9OgDP8ccALpMfQ4fEB4AoBnsQETI90c8YewrgI6hzwEADCBARMz3Rzxh7CuAlqPPAQAMIUC0wN2nzx768yPojwDQJvQ5AIBB9EC0gH9z/cDXBQNAG9DnAABGsQPRMnefPrvnpzXRHwEgRvQ5AIBxBIiWuvv02X0fJOiPABAD+hwAIBIEiJa7+/SZeiMe0h8BwCj6HAAgMgSIDrj79NltvxvxRdevBQBT/u7Dw5inBQDiQYDoED/29RH9EQAaRp8DAESMANFBd58+e+CDBP0RAOpEnwMAtAABoqN8WZN6I77s+rUAUDn6HACgRQgQHXf36bMPfH/E512/FgAqQZ8DALQMAQI53x+hIPERVwRAAPQ5AEBLESDwDt8f8ZixrwBWRJ8DALQcAQLv8f0RarL+K1cHQEn0OQBARxAgcCXfH/GEsa8ArkGfAwB0CAEC1/L9EU8Y+wrgAvocAKCDCBAo7e7TZw99aRP9EUC3qc/h4c+fffh11y8EAHQRAQJL8f0RqnH+gisHdI76HB7//NmHj3jqAaC7CBBYyd2nz+75IEF/BNANX/ldB/ocAKDjCBBYy92nz+77IEF/BNBO3/rg8D3PLwDAESAQyt2nz1TS8JD+CKA16HMAAFyKAIFg/NjXR/RHAFGjzwEAsBABAsH5sa+P6I8AokOfAwDgWgQIVObu02cPfH8EZU2AbfQ5AABKI0CgUn7sq3ojvuRKA+bQ5wAAWBoBArXw/RHajficKw40jj4HAMDKCBCole+PUJD4iCsPNII+BwDAWggQaMTdp88e+kZr+iOAetDnAAAIggCBxvj+CIWIv/IsAJWhzwEAEBQBAo3z/RFPGPsKBEWfAwCgEgQImOH7IxQk/sKzAqyFPgcAQGUIEDDn7tNnj/zoV/ojgOXQ5wAAqBwBAib5/ghNa/qCZwi4Fn0OAIDaECBg2t2nz+75IEF/BPA++hwAALUjQCAKd58+e+AnNtEfAczQ5wAAaAQBAtHwZU0P6Y9Ax9HnAABoFAEC0fFjXx/RH4GOoc8BAGACAQLR8mNf1R/xEc8iWow+BwCAKQQIRM/3RzymrAktRJ8DAMAcAgRaYa4/4kueUbSA+hwe/fzZh9/wZAIArCFAoFV8f4R2Iz7nmUWEfvLB4QlPHgDAKgIEWsn3Rzxh7CsiceCD72PKlQAA1hEg0Gp3nz576Cc20R8Bq77yuw4/8gwBAGJAgEDr+f4IhYi/8mzDEPocAABRIkCgM3x/hMqaPuZZR4PocwAARI0Agc65+/TZfV9vTn8E6kSfAwCgFQgQ6Ky7T5898qNf6Y9A1ehzAAC0BgECneb7I3RX+IuuXwtUgj4HAEDrECCAt2NfH9EfgUDocwAAtBYBAphz9+mzBz5I0B+BVdDnAABoPQIEcIEva3pIfwSWRJ8DAKATCBDAFfzYV91N/pxrhAXocwAAdAoBAriG749QkPj92xPMAAADC0lEQVSIa4U59DkAADqJAAGU5PsjHlPW1Hn0OQAAOo0AASxhrj/iS65bJ9HnAADoPAIEsALfH/GEsa+dQZ8DAAAeAQJYg++PeMLY19aizwEAgAsIEEAAd58+e+jPj6A/oh3ocwAA4AoECCAQ3x+hEPFXrmnU6HMAAGABAgQQ2N2nz+75u9f0R8SFPgcAAEogQAAVufv02X0fJOiPsI0+BwAAlkCAACp29+mzR370K/0R9vyNPgcAAJZDgABq4PsjtBvxBdfbhH8q1NHnAADA8ggQQI38+RGPCBKN+cEHB/ocAABYEQECaABBonYHPjjQ5wAAwJoIEECDCBK1oM8BAICACBCAAb5HQo3WD5jaFAznOQAAUAECBGCMH/+qIPE5z81KCA4AAFSIAAEY5cubijDxEc/TQupxeOJLlQgOAABUiAABRIAwcaUf/Hjcr+lxwP/f3r2cNgyEURgd0kA6CF6oAHUQF6BitUgBdgcqwCtVkBLCwCwGguFCINbjHBg8G4Msrz5+PQD4HwICdqaLietJL3Oqb46eTRsA4DUEBOzcx9fj2mKirs+D/p/3Fg2zaACA1xIQcDAtKMYWFONOn+pUg6G+7G1Zp2HewPEAAI2AgINrj4gd27p0+/cN/PJ68/PSr3Ualg0cFwDwhICAE2vTitKmFaUFxqXb/3V6ce/2t/ZZA+F7nYbbk+8AABsmIIBYN834RRAAwDkICAAAIPbmVAEAACkBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAECmlPIDmb9AJu2dyFAAAAAASUVORK5CYII=\",\n \"targetType\" : \"TENANT_LEVEL\",\n \"description\" : \"description\",\n \"supportedPlatforms\" : [ {\n \"name\" : \"AZURE\",\n \"kind\" : \"meshPlatformType\"\n } ],\n \"runTransparency\" : false,\n \"useInLandingZonesOnly\" : false,\n \"supportUrl\" : \"https://example.com\",\n \"documentationUrl\" : \"https://example.com\",\n \"notificationSubscriberUsernames\" : [ ]\n },\n \"status\" : {\n \"versions\" : [ {\n \"versionUuid\" : \"b5d96b59-cd43-417b-ac22-f9d0e3066456\",\n \"versionNumber\" : 1,\n \"state\" : \"DRAFT\"\n } ],\n \"latestVersion\" : 1,\n \"latestVersionUuid\" : \"b5d96b59-cd43-417b-ac22-f9d0e3066456\",\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:03.847693682Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/my-workspace\"\n },\n \"buildingblocks\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks?definitionUuid=ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\"\n },\n \"versions\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockdefinitionversions": {
"get": {
"tags": [
"Building Block Definition Versions"
],
"summary": "List building block definition versions for a specific definition",
"description": "List all versions of a specific building block definition. Versions are returned sorted by version number in descending order (newest first).\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionVersion-list-V1-",
"parameters": [
{
"name": "buildingBlockDefinitionUuid",
"in": "query",
"description": "UUID of the building block definition to retrieve versions for. (required)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionVersion-list-V1-githubWorkflows"
},
"examples": {
"meshBuildingBlockDefinitionVersion-list-V1-githubWorkflows": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockDefinitionVersions\" : [ {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"8f0adb54-d722-412c-be1f-ec6a8e34c739\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"8794362e-f8a4-49f4-bb81-cad0743a4eed\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"githubWorkflows\",\n \"githubWorkflows\" : {\n \"repository\" : \"git@github.com:example/building-block.git\",\n \"branch\" : \"main\",\n \"applyWorkflow\" : \"apply.yml\",\n \"destroyWorkflow\" : \"destroy.yml\",\n \"async\" : true,\n \"omitRunObjectInput\" : false,\n \"integrationRef\" : {\n \"uuid\" : \"308decb2-8986-4421-bf17-28ba78a2a385\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:06.680656028Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/8f0adb54-d722-412c-be1f-ec6a8e34c739\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/8794362e-f8a4-49f4-bb81-cad0743a4eed\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"4fba6151-bd79-448d-9fe1-6fb5f188410c\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"8794362e-f8a4-49f4-bb81-cad0743a4eed\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 1,\n \"state\" : \"RELEASED\",\n \"implementation\" : {\n \"type\" : \"githubWorkflows\",\n \"githubWorkflows\" : {\n \"repository\" : \"git@github.com:example/building-block.git\",\n \"branch\" : \"main\",\n \"applyWorkflow\" : \"apply.yml\",\n \"destroyWorkflow\" : \"destroy.yml\",\n \"async\" : true,\n \"omitRunObjectInput\" : false,\n \"integrationRef\" : {\n \"uuid\" : \"308decb2-8986-4421-bf17-28ba78a2a385\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"databaseName\" : {\n \"displayName\" : \"databaseName\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"my-database\",\n \"description\" : \"The name of the database to create\"\n },\n \"projectId\" : {\n \"displayName\" : \"projectId\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"PROJECT_IDENTIFIER\",\n \"isEnvironment\" : true,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : false\n }\n },\n \"outputs\" : {\n \"connectionString\" : {\n \"displayName\" : \"connectionString\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n },\n \"endpoint\" : {\n \"displayName\" : \"endpoint\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"RESOURCE_URL\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"RELEASED\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:06.503851733Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/4fba6151-bd79-448d-9fe1-6fb5f188410c\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/8794362e-f8a4-49f4-bb81-cad0743a4eed\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=8794362e-f8a4-49f4-bb81-cad0743a4eed&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
},
"meshBuildingBlockDefinitionVersion-list-V1-gitlabPipeline": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockDefinitionVersions\" : [ {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"83bddae0-2c0c-471d-839c-5f2316e92978\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"gitlabPipeline\",\n \"gitlabPipeline\" : {\n \"projectId\" : \"project-id\",\n \"refName\" : \"main\",\n \"pipelineTriggerToken\" : {\n \"hash\" : \"sha256:1cc75ffe17505a665abbf809f45babf600e16725752d4d0fe0d2b9fcc0a49c42\"\n },\n \"integrationRef\" : {\n \"uuid\" : \"d4b7f45a-4e7c-4fee-a9d3-51ef1db6da6d\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:07.511169703Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/83bddae0-2c0c-471d-839c-5f2316e92978\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"96f85d63-14fd-49b1-b742-581b9e5e6819\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 1,\n \"state\" : \"RELEASED\",\n \"implementation\" : {\n \"type\" : \"gitlabPipeline\",\n \"gitlabPipeline\" : {\n \"projectId\" : \"project-id\",\n \"refName\" : \"main\",\n \"pipelineTriggerToken\" : {\n \"hash\" : \"sha256:1cc75ffe17505a665abbf809f45babf600e16725752d4d0fe0d2b9fcc0a49c42\"\n },\n \"integrationRef\" : {\n \"uuid\" : \"d4b7f45a-4e7c-4fee-a9d3-51ef1db6da6d\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"databaseName\" : {\n \"displayName\" : \"databaseName\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"my-database\",\n \"description\" : \"The name of the database to create\"\n },\n \"projectId\" : {\n \"displayName\" : \"projectId\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"PROJECT_IDENTIFIER\",\n \"isEnvironment\" : true,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : false\n }\n },\n \"outputs\" : {\n \"connectionString\" : {\n \"displayName\" : \"connectionString\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n },\n \"endpoint\" : {\n \"displayName\" : \"endpoint\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"RESOURCE_URL\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"RELEASED\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:07.336899368Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/96f85d63-14fd-49b1-b742-581b9e5e6819\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=d2683f3c-052f-4ef5-a7d0-25aa7c265d1c&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
},
"meshBuildingBlockDefinitionVersion-list-V1-terraform": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockDefinitionVersions\" : [ {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"4110a6fe-7133-4904-84ec-47881e5fb107\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"terraform\",\n \"terraform\" : {\n \"terraformVersion\" : \"1.11.0\",\n \"repositoryUrl\" : \"git@github.com:example/building-block.git\",\n \"async\" : false,\n \"repositoryPath\" : \"path/to/sources\",\n \"refName\" : \"main\",\n \"sshPrivateKey\" : {\n \"hash\" : \"sha256:b34e0aca1509b8f63d0a0204bb84c43546c06dd0a48abc1a51e27c978136c3b0\"\n },\n \"sshKnownHost\" : {\n \"host\" : \"github.com\",\n \"keyType\" : \"ssh-rsa\",\n \"keyValue\" : \"AAAAB3NzaC1yc2EAAAABIwAAA...\"\n },\n \"useMeshHttpBackendFallback\" : true,\n \"preRunScript\" : \"echo \\\"Running pre-run script\\\"\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"66ddc814-1e69-4dad-b5f1-3a5bce51c01f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:05.808280594Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/4110a6fe-7133-4904-84ec-47881e5fb107\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"77635f73-4054-45ce-859d-2c90266899ee\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 1,\n \"state\" : \"RELEASED\",\n \"implementation\" : {\n \"type\" : \"terraform\",\n \"terraform\" : {\n \"terraformVersion\" : \"1.11.0\",\n \"repositoryUrl\" : \"git@github.com:example/building-block.git\",\n \"async\" : false,\n \"repositoryPath\" : \"path/to/sources\",\n \"refName\" : \"main\",\n \"sshPrivateKey\" : {\n \"hash\" : \"sha256:b34e0aca1509b8f63d0a0204bb84c43546c06dd0a48abc1a51e27c978136c3b0\"\n },\n \"sshKnownHost\" : {\n \"host\" : \"github.com\",\n \"keyType\" : \"ssh-rsa\",\n \"keyValue\" : \"AAAAB3NzaC1yc2EAAAABIwAAA...\"\n },\n \"useMeshHttpBackendFallback\" : true,\n \"preRunScript\" : \"echo \\\"Running pre-run script\\\"\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"66ddc814-1e69-4dad-b5f1-3a5bce51c01f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"databaseName\" : {\n \"displayName\" : \"databaseName\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"my-database\",\n \"description\" : \"The name of the database to create\"\n },\n \"projectId\" : {\n \"displayName\" : \"projectId\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"PROJECT_IDENTIFIER\",\n \"isEnvironment\" : true,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : false\n }\n },\n \"outputs\" : {\n \"connectionString\" : {\n \"displayName\" : \"connectionString\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n },\n \"endpoint\" : {\n \"displayName\" : \"endpoint\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"RESOURCE_URL\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"RELEASED\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:05.622376619Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/77635f73-4054-45ce-859d-2c90266899ee\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=a279d73f-01dd-4e17-89ed-3ab3f02a3f4f&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
},
"meshBuildingBlockDefinitionVersion-list-V1-azureDevOpsPipeline": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockDefinitionVersions\" : [ {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"a888ac98-8600-440d-9e4e-9a61f51f7f4a\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"f0c57904-7c4a-4801-95e1-a3b8f3fc5719\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"azureDevOpsPipeline\",\n \"azureDevOpsPipeline\" : {\n \"project\" : \"example-project\",\n \"pipelineId\" : \"pipeline-id\",\n \"async\" : true,\n \"integrationRef\" : {\n \"uuid\" : \"61d30736-29dd-45ff-bcf9-615ad8c8ca12\",\n \"kind\" : \"meshIntegration\"\n },\n \"refName\" : \"refs/heads/feature/my-branch\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:08.335331718Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/a888ac98-8600-440d-9e4e-9a61f51f7f4a\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/f0c57904-7c4a-4801-95e1-a3b8f3fc5719\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"05fed15e-4fd6-428d-b54e-c8cdcba1ded3\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"f0c57904-7c4a-4801-95e1-a3b8f3fc5719\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 1,\n \"state\" : \"RELEASED\",\n \"implementation\" : {\n \"type\" : \"azureDevOpsPipeline\",\n \"azureDevOpsPipeline\" : {\n \"project\" : \"example-project\",\n \"pipelineId\" : \"pipeline-id\",\n \"async\" : true,\n \"integrationRef\" : {\n \"uuid\" : \"61d30736-29dd-45ff-bcf9-615ad8c8ca12\",\n \"kind\" : \"meshIntegration\"\n },\n \"refName\" : \"refs/heads/feature/my-branch\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"databaseName\" : {\n \"displayName\" : \"databaseName\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"my-database\",\n \"description\" : \"The name of the database to create\"\n },\n \"projectId\" : {\n \"displayName\" : \"projectId\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"PROJECT_IDENTIFIER\",\n \"isEnvironment\" : true,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : false\n }\n },\n \"outputs\" : {\n \"connectionString\" : {\n \"displayName\" : \"connectionString\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n },\n \"endpoint\" : {\n \"displayName\" : \"endpoint\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"RESOURCE_URL\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"RELEASED\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:08.160622843Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/05fed15e-4fd6-428d-b54e-c8cdcba1ded3\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/f0c57904-7c4a-4801-95e1-a3b8f3fc5719\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=f0c57904-7c4a-4801-95e1-a3b8f3fc5719&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
},
"meshBuildingBlockDefinitionVersion-list-V1-manual": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockDefinitionVersions\" : [ {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"5d1e4788-4eaa-4c6a-a562-5bed6e008437\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"manual\"\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"46b7c17a-61f0-4062-9601-5785e60ce11f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example\" : {\n \"displayName\" : \"Example\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:04.836460603Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/5d1e4788-4eaa-4c6a-a562-5bed6e008437\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"9b286e60-54ec-409f-aaa4-9c8178f9bd81\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 1,\n \"state\" : \"RELEASED\",\n \"implementation\" : {\n \"type\" : \"manual\"\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"46b7c17a-61f0-4062-9601-5785e60ce11f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"databaseName\" : {\n \"displayName\" : \"databaseName\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"my-database\",\n \"description\" : \"The name of the database to create\"\n },\n \"projectId\" : {\n \"displayName\" : \"projectId\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"PROJECT_IDENTIFIER\",\n \"isEnvironment\" : true,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : false\n }\n },\n \"outputs\" : {\n \"connectionString\" : {\n \"displayName\" : \"connectionString\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n },\n \"endpoint\" : {\n \"displayName\" : \"endpoint\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"RESOURCE_URL\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"RELEASED\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:04.573339410Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/9b286e60-54ec-409f-aaa4-9c8178f9bd81\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=48d56ed7-cfbe-4716-ad2f-59c5bcd50d76&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Building Block Definition Versions"
],
"summary": "Create a new Building Block Definition Version",
"description": "Creates a new Building Block Definition Version with the specified implementation type.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionVersion-post-V1-",
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json"
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockdefinitionversions2142249952"
},
"examples": {
"meshBuildingBlockDefinitionVersion-post-V1-terraform": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"terraform\",\"terraform\":{\"terraformVersion\":\"1.11.0\",\"repositoryUrl\":\"git@github.com:example/building-block.git\",\"async\":false,\"repositoryPath\":\"path/to/sources\",\"refName\":\"main\",\"sshPrivateKey\":{\"plaintext\":\"example-secret\"},\"sshKnownHost\":{\"host\":\"github.com\",\"keyType\":\"ssh-rsa\",\"keyValue\":\"AAAAB3NzaC1yc2EAAAABIwAAA...\"},\"useMeshHttpBackendFallback\":true,\"preRunScript\":\"echo \\\"Running pre-run script\\\"\"}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"66ddc814-1e69-4dad-b5f1-3a5bce51c01f\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-azureDevOpsPipeline": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"f0c57904-7c4a-4801-95e1-a3b8f3fc5719\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"azureDevOpsPipeline\",\"azureDevOpsPipeline\":{\"project\":\"example-project\",\"pipelineId\":\"pipeline-id\",\"async\":true,\"integrationRef\":{\"uuid\":\"61d30736-29dd-45ff-bcf9-615ad8c8ca12\",\"kind\":\"meshIntegration\"},\"refName\":\"refs/heads/feature/my-branch\"}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"05cfa85f-2818-4bdd-b193-620e0187d7de\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-gitlabPipeline": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"gitlabPipeline\",\"gitlabPipeline\":{\"projectId\":\"project-id\",\"refName\":\"main\",\"pipelineTriggerToken\":{\"plaintext\":\"example-secret\"},\"integrationRef\":{\"uuid\":\"d4b7f45a-4e7c-4fee-a9d3-51ef1db6da6d\",\"kind\":\"meshIntegration\"}}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-manual": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"manual\"},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"PURGE\",\n \"permissions\": [],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"46b7c17a-61f0-4062-9601-5785e60ce11f\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n },\n \n \"outputs\": {\n \"example\": {\n \"displayName\": \"Example\",\n \"type\": \"STRING\",\n \"assignmentType\": \"NONE\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-githubWorkflows": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"8794362e-f8a4-49f4-bb81-cad0743a4eed\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"githubWorkflows\",\"githubWorkflows\":{\"repository\":\"git@github.com:example/building-block.git\",\"branch\":\"main\",\"applyWorkflow\":\"apply.yml\",\"destroyWorkflow\":\"destroy.yml\",\"async\":true,\"omitRunObjectInput\":false,\"integrationRef\":{\"uuid\":\"308decb2-8986-4421-bf17-28ba78a2a385\",\"kind\":\"meshIntegration\"}}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionVersion-post-V1-terraform"
},
"examples": {
"meshBuildingBlockDefinitionVersion-post-V1-terraform": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"4110a6fe-7133-4904-84ec-47881e5fb107\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"terraform\",\n \"terraform\" : {\n \"terraformVersion\" : \"1.11.0\",\n \"repositoryUrl\" : \"git@github.com:example/building-block.git\",\n \"async\" : false,\n \"repositoryPath\" : \"path/to/sources\",\n \"refName\" : \"main\",\n \"sshPrivateKey\" : {\n \"hash\" : \"sha256:f11aefcce66c8493feb82c72c36892a42334b6d71055c829a5ac7cbd1fad22fa\"\n },\n \"sshKnownHost\" : {\n \"host\" : \"github.com\",\n \"keyType\" : \"ssh-rsa\",\n \"keyValue\" : \"AAAAB3NzaC1yc2EAAAABIwAAA...\"\n },\n \"useMeshHttpBackendFallback\" : true,\n \"preRunScript\" : \"echo \\\"Running pre-run script\\\"\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"66ddc814-1e69-4dad-b5f1-3a5bce51c01f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:05.808280594Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/4110a6fe-7133-4904-84ec-47881e5fb107\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-azureDevOpsPipeline": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"a888ac98-8600-440d-9e4e-9a61f51f7f4a\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"f0c57904-7c4a-4801-95e1-a3b8f3fc5719\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"azureDevOpsPipeline\",\n \"azureDevOpsPipeline\" : {\n \"project\" : \"example-project\",\n \"pipelineId\" : \"pipeline-id\",\n \"async\" : true,\n \"integrationRef\" : {\n \"uuid\" : \"61d30736-29dd-45ff-bcf9-615ad8c8ca12\",\n \"kind\" : \"meshIntegration\"\n },\n \"refName\" : \"refs/heads/feature/my-branch\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:08.335331718Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/a888ac98-8600-440d-9e4e-9a61f51f7f4a\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/f0c57904-7c4a-4801-95e1-a3b8f3fc5719\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-gitlabPipeline": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"83bddae0-2c0c-471d-839c-5f2316e92978\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"gitlabPipeline\",\n \"gitlabPipeline\" : {\n \"projectId\" : \"project-id\",\n \"refName\" : \"main\",\n \"pipelineTriggerToken\" : {\n \"hash\" : \"sha256:dc56154e784a7399cb56d89ee826bba9cddcf1812970c2810ee1bde96cb509cc\"\n },\n \"integrationRef\" : {\n \"uuid\" : \"d4b7f45a-4e7c-4fee-a9d3-51ef1db6da6d\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:07.511169703Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/83bddae0-2c0c-471d-839c-5f2316e92978\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-manual": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"5d1e4788-4eaa-4c6a-a562-5bed6e008437\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"manual\"\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"46b7c17a-61f0-4062-9601-5785e60ce11f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example\" : {\n \"displayName\" : \"Example\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:04.836460603Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/5d1e4788-4eaa-4c6a-a562-5bed6e008437\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-post-V1-githubWorkflows": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"8f0adb54-d722-412c-be1f-ec6a8e34c739\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"8794362e-f8a4-49f4-bb81-cad0743a4eed\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"githubWorkflows\",\n \"githubWorkflows\" : {\n \"repository\" : \"git@github.com:example/building-block.git\",\n \"branch\" : \"main\",\n \"applyWorkflow\" : \"apply.yml\",\n \"destroyWorkflow\" : \"destroy.yml\",\n \"async\" : true,\n \"omitRunObjectInput\" : false,\n \"integrationRef\" : {\n \"uuid\" : \"308decb2-8986-4421-bf17-28ba78a2a385\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:06.680656028Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/8f0adb54-d722-412c-be1f-ec6a8e34c739\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/8794362e-f8a4-49f4-bb81-cad0743a4eed\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockrunners": {
"get": {
"tags": [
"Building Block Runners"
],
"summary": "List building block runners",
"description": "Provides a paged list of meshBuildingBlockRunners owned by or accessible to the caller.\n\nFilter results using `workspaceIdentifier` to scope the list to a specific workspace.\nWhen called with workspace-scoped credentials, only runners owned by that workspace are returned.\nWhen called with admin credentials, all runners visible to the caller are returned.\n\n**Note**: The meshBuildingBlockRunner API is still in preview (`v1-preview`), which means it is subject\nto change without prior notice and we do not guarantee backwards compatibility. Breaking changes may be\nintroduced in future versions. If this is not acceptable for your use case, please wait until the\nstable version is announced in the release notes.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunner-List",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter by the identifier of the workspace that owns the runner.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunner-List"
},
"examples": {
"meshBuildingBlockRunner-List": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockRunners\" : [ {\n \"kind\" : \"meshBuildingBlockRunner\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"40986235-fb2a-440f-9bcd-292fbad9ca08\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"createdOn\" : \"2026-06-03T14:05:10.656878818Z\",\n \"lastSeen\" : \"2026-06-03T14:05:10.656878818Z\"\n },\n \"spec\" : {\n \"displayName\" : \"my-terraform-runner\",\n \"publicKey\" : \"-----BEGIN CERTIFICATE-----\\nMIIE/zCCAuegAwIBAgIUCSNWLAVNiOYz0XnhGTh4sZr2/8YwDQYJKoZIhvcNAQEL\\nBQAwDzENMAsGA1UEAwwEdGVzdDAeFw0yNTA5MTkwODU4MTFaFw0yNjA5MTkwODU4\\nMTFaMA8xDTALBgNVBAMMBHRlc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK\\nAoICAQC9NNiRNKS4nunZ02vi8goUfn3HH8KhPVOtvpTDcb7omOyGAq66uXqZxa3o\\n3eZu3RGCEIooXHlv2zBcT7Hz7OovmJEEhH4+OfH+ZDXFAYUgvOz/NuuwSQgCpSow\\nX/q8m7eESFb8X7ldu8s5SsJ2JFLjIyxVoX2wGDXUZnJVujIxjTj32MdokxKXkrxd\\ncwS6vzpNZp8E6F6pdBke6dKhb+24Gra3/ISqjmTf5VMMSLBKDEe8CUbEELzIkbXG\\nTj1z3xu3NdpVD4i9Q6pa4bYSeSexybVWPBHYM3SEVfcvyqks/WhQDhISgYaTVtDA\\nSQ+Tln24JMmUHs5ENl/wYnJY5ovDSWoolNMiQY7XddQImmxZ8zmBU+2hViDQq4W+\\nBQn8miOoBww1GUjxUCKDgBGzDSu3SvP1o2K4U5L0TAIg5W6JgN/+333AQ7iIRErc\\nEGO82ftzNiP/eHXz2S6Z97BBHGVHFrxJUPho9lVd5MrvKhqRZULiGIPmqgtZNMJo\\nWnD1UlMjJQOsf2K0qaiMW32738azLQ8oBWQ05tpXUh0ChfvKSpYPoSGp0QWV+U8O\\nGMUGSBdILISagFMn4zWy67JBWRDYuNmuzrBgWe8ZhLAMhNtRPG8SZIy0Xp+g0GUN\\n6/LIDuk1zTHAwC2CaNBJgRJOleheNtQOBY8hhAVWlHLrkB4bDQIDAQABo1MwUTAd\\nBgNVHQ4EFgQUHVo5FXwCa2ou5ahhk7OJXElQ0/gwHwYDVR0jBBgwFoAUHVo5FXwC\\na2ou5ahhk7OJXElQ0/gwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOC\\nAgEACkflInpnLpcBFSkG3IFN5EEDM5HEUnnu01M/GTbPATC8umWDxKKNxdl5jkZd\\nLtrS7U8LTwleM2rktRBL7jq/oUbJaQLw78AaK3cc/6S/p7nq7DdWhgqFOj3+H+Ik\\n+XEcco6vET6R0Ow1Lqt9f3JV9xq93WwZeYGBZ4mP3hrmacQf7GPCJgdS8dy1H2fq\\nCt0DxPHYnKgkEr7e3MJBpGrpq5A5g9uJNWDLhs7s2FvjW7kFUTj1OsJDRU7Bc8eY\\nXXgUOb8lRPc9wE5TN2RZ5Ghp82jAxuSh8syD28AoIHq8UIaBrTUYnTB06j7IiaZ7\\nkOylLkCH4rrbOFW9N8XutHjUNu9gxtv1v94nzWuT5RX1/cqazjHSnqykjNsT3ZcX\\nOxGNjIIGsFh7bOnsZ7U+lmOmfmUkxBWrpHcw4dTe2OzhiccjoSDtWsQOPANmGgzY\\n8Iemh6v5zXM3sYHzJliswpawNLv9sNPkIb0NGiRWs2VimbaYrE4404EXRllKUJwj\\n2OROpr2uw86pPOyhpNaJjGyoJPOM71Wvx8vqUoINFRJRsj62uEWYpcN1+b4835S/\\nizawL1nW2+w6+DVnXu4oRotQ40MOW9DSESZoKnA0sJZ9KkOEkthBHmlErKa9iq/1\\nEsPBbtuo0C0zB4k9MPfbmkmLy0oQBZNBjDbkeCHWPxtPExY=\\n-----END CERTIFICATE-----\",\n \"implementationType\" : \"TERRAFORM\",\n \"restriction\" : \"PRIVATE\",\n \"isSelfHosted\" : true\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockrunners/40986235-fb2a-440f-9bcd-292fbad9ca08\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlockRunner\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"8e837567-36c3-418f-9911-b2a383cc3589\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"createdOn\" : \"2026-06-03T14:05:10.659633558Z\",\n \"lastSeen\" : \"2026-06-03T14:05:10.659633558Z\"\n },\n \"spec\" : {\n \"displayName\" : \"runner-to-delete\",\n \"publicKey\" : \"-----BEGIN CERTIFICATE-----\\nMIIE/zCCAuegAwIBAgIUCSNWLAVNiOYz0XnhGTh4sZr2/8YwDQYJKoZIhvcNAQEL\\nBQAwDzENMAsGA1UEAwwEdGVzdDAeFw0yNTA5MTkwODU4MTFaFw0yNjA5MTkwODU4\\nMTFaMA8xDTALBgNVBAMMBHRlc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK\\nAoICAQC9NNiRNKS4nunZ02vi8goUfn3HH8KhPVOtvpTDcb7omOyGAq66uXqZxa3o\\n3eZu3RGCEIooXHlv2zBcT7Hz7OovmJEEhH4+OfH+ZDXFAYUgvOz/NuuwSQgCpSow\\nX/q8m7eESFb8X7ldu8s5SsJ2JFLjIyxVoX2wGDXUZnJVujIxjTj32MdokxKXkrxd\\ncwS6vzpNZp8E6F6pdBke6dKhb+24Gra3/ISqjmTf5VMMSLBKDEe8CUbEELzIkbXG\\nTj1z3xu3NdpVD4i9Q6pa4bYSeSexybVWPBHYM3SEVfcvyqks/WhQDhISgYaTVtDA\\nSQ+Tln24JMmUHs5ENl/wYnJY5ovDSWoolNMiQY7XddQImmxZ8zmBU+2hViDQq4W+\\nBQn8miOoBww1GUjxUCKDgBGzDSu3SvP1o2K4U5L0TAIg5W6JgN/+333AQ7iIRErc\\nEGO82ftzNiP/eHXz2S6Z97BBHGVHFrxJUPho9lVd5MrvKhqRZULiGIPmqgtZNMJo\\nWnD1UlMjJQOsf2K0qaiMW32738azLQ8oBWQ05tpXUh0ChfvKSpYPoSGp0QWV+U8O\\nGMUGSBdILISagFMn4zWy67JBWRDYuNmuzrBgWe8ZhLAMhNtRPG8SZIy0Xp+g0GUN\\n6/LIDuk1zTHAwC2CaNBJgRJOleheNtQOBY8hhAVWlHLrkB4bDQIDAQABo1MwUTAd\\nBgNVHQ4EFgQUHVo5FXwCa2ou5ahhk7OJXElQ0/gwHwYDVR0jBBgwFoAUHVo5FXwC\\na2ou5ahhk7OJXElQ0/gwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOC\\nAgEACkflInpnLpcBFSkG3IFN5EEDM5HEUnnu01M/GTbPATC8umWDxKKNxdl5jkZd\\nLtrS7U8LTwleM2rktRBL7jq/oUbJaQLw78AaK3cc/6S/p7nq7DdWhgqFOj3+H+Ik\\n+XEcco6vET6R0Ow1Lqt9f3JV9xq93WwZeYGBZ4mP3hrmacQf7GPCJgdS8dy1H2fq\\nCt0DxPHYnKgkEr7e3MJBpGrpq5A5g9uJNWDLhs7s2FvjW7kFUTj1OsJDRU7Bc8eY\\nXXgUOb8lRPc9wE5TN2RZ5Ghp82jAxuSh8syD28AoIHq8UIaBrTUYnTB06j7IiaZ7\\nkOylLkCH4rrbOFW9N8XutHjUNu9gxtv1v94nzWuT5RX1/cqazjHSnqykjNsT3ZcX\\nOxGNjIIGsFh7bOnsZ7U+lmOmfmUkxBWrpHcw4dTe2OzhiccjoSDtWsQOPANmGgzY\\n8Iemh6v5zXM3sYHzJliswpawNLv9sNPkIb0NGiRWs2VimbaYrE4404EXRllKUJwj\\n2OROpr2uw86pPOyhpNaJjGyoJPOM71Wvx8vqUoINFRJRsj62uEWYpcN1+b4835S/\\nizawL1nW2+w6+DVnXu4oRotQ40MOW9DSESZoKnA0sJZ9KkOEkthBHmlErKa9iq/1\\nEsPBbtuo0C0zB4k9MPfbmkmLy0oQBZNBjDbkeCHWPxtPExY=\\n-----END CERTIFICATE-----\",\n \"implementationType\" : \"TERRAFORM\",\n \"restriction\" : \"PRIVATE\",\n \"isSelfHosted\" : true\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockrunners/8e837567-36c3-418f-9911-b2a383cc3589\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockrunners?workspaceIdentifier=platform-team&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Building Block Runners"
],
"summary": "Create building block runner",
"description": "Create a new meshBuildingBlockRunner.\n\nThe `spec.publicKey` must be a valid RSA public key in PEM format (BEGIN PUBLIC KEY) or an X.509 \ncertificate (BEGIN CERTIFICATE). meshStack uses this public key to encrypt secrets that are sent to \nthe runner at execution time.\n\nThe `spec.workloadIdentityFederation` section is optional. When provided, it configures the runner\nto use short-lived federated identity tokens for cloud provider authentication instead of\nlong-lived credentials. At least one of `gcp`, `aws`, or `azure` must be populated when\n`workloadIdentityFederation` is specified.\n\nThe `metadata.uuid` must not be provided on creation. meshStack assigns a UUID automatically and\nreturns it in the response.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunner-Post",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockrunners-buildingBlockRunnerUuid816872201"
},
"examples": {
"meshBuildingBlockRunner-Post": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockRunner\",\n \"metadata\": {\n \"ownedByWorkspace\": \"platform-team\"\n },\n \"spec\": {\n \"displayName\": \"My Terraform Runner\",\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----\\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAqy2py5uFX9LfQgiM2Zd+\\nQm1NcZWKX8TqCQJKZ0Qa9R+BoERbVBoLM4DdY67DAr6b1E08QRfI2EnF0w6zJ7R/\\n0oAkba0lLnT5S9FX6OVUzDvGDOc+5JqBwlK2UibJLmBhX0qnDMvRWBrJLV71yTHj\\njOThfVwNzVaijwmV+y8BQKa6PnoHixuiAoKYCUe4UrEke0tPdstIvrUY/gb9sU57\\nwkfBhYv+RnHuLT1IOGm/uidUMj94jd5mSjYPcuwcVfjTXS8+6TXH5kdqMfigPOER\\n5bmfgBOlJWQUeGojApLJLmSgpVZAIKDHK6i0IzB7QkGRma5llqXVbwnYP+0fOJkR\\nmwGj5FL7M30akGrT2MCslebQ/y+hV/3tnWSfONCWqs3S8yU/mHDMj+DoileGAVmF\\nMjH16sRbA5H3sMjhU49hVDGxaP6FVVK3H0GuPE+WDXRqhhdwPsgLjNAj4P1K0VPL\\nM8gadyGuZjiP4OH3o0sBQcF6cIP6cyK/ms1Y6qg9elqI9RisbGL9WIAVRuPWulsR\\n0AksHEI864yD/Kp2y5QhRO2G7Zl0tc4Wu7mU6Gdb7lRDjZEOm9ArpsWpnp37Tl5a\\nYfm5/6ybSx3X7B57F1PxIqQILT0xSeuyXSiXdRPJesot0Un8/U9SWW7vSiYq4ibA\\nwvivfHtouj93yaMWdLlqodUCAwEAAQ==\\n-----END PUBLIC KEY-----\",\n \"implementationType\": \"TERRAFORM\",\n \"workloadIdentityFederation\": {\n \"issuer\": \"https://oidc.example.com\",\n \"subject\": \"system:serviceaccount:meshfed:my-runner\",\n \"gcp\": {\n \"audience\": \"//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/my-provider\",\n \"tokenPath\": \"/var/run/secrets/workload-identity/gcp/token\"\n },\n \"aws\": {\n \"audience\": \"sts.amazonaws.com\",\n \"tokenPath\": \"/var/run/secrets/workload-identity/aws/token\"\n },\n \"azure\": {\n \"audience\": \"api://AzureADTokenExchange\",\n \"tokenPath\": \"/var/run/secrets/workload-identity/azure/token\"\n }\n }\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunner-Post"
},
"examples": {
"meshBuildingBlockRunner-Post": {
"value": "{\n \"kind\" : \"meshBuildingBlockRunner\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"00aab55a-fb6e-4e0b-8aaf-65021d4a973e\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"createdOn\" : \"2026-06-03T14:05:11.357299657Z\",\n \"lastSeen\" : \"2026-06-03T14:05:11.357299657Z\"\n },\n \"spec\" : {\n \"displayName\" : \"My Terraform Runner\",\n \"publicKey\" : \"-----BEGIN PUBLIC KEY-----\\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAqy2py5uFX9LfQgiM2Zd+\\nQm1NcZWKX8TqCQJKZ0Qa9R+BoERbVBoLM4DdY67DAr6b1E08QRfI2EnF0w6zJ7R/\\n0oAkba0lLnT5S9FX6OVUzDvGDOc+5JqBwlK2UibJLmBhX0qnDMvRWBrJLV71yTHj\\njOThfVwNzVaijwmV+y8BQKa6PnoHixuiAoKYCUe4UrEke0tPdstIvrUY/gb9sU57\\nwkfBhYv+RnHuLT1IOGm/uidUMj94jd5mSjYPcuwcVfjTXS8+6TXH5kdqMfigPOER\\n5bmfgBOlJWQUeGojApLJLmSgpVZAIKDHK6i0IzB7QkGRma5llqXVbwnYP+0fOJkR\\nmwGj5FL7M30akGrT2MCslebQ/y+hV/3tnWSfONCWqs3S8yU/mHDMj+DoileGAVmF\\nMjH16sRbA5H3sMjhU49hVDGxaP6FVVK3H0GuPE+WDXRqhhdwPsgLjNAj4P1K0VPL\\nM8gadyGuZjiP4OH3o0sBQcF6cIP6cyK/ms1Y6qg9elqI9RisbGL9WIAVRuPWulsR\\n0AksHEI864yD/Kp2y5QhRO2G7Zl0tc4Wu7mU6Gdb7lRDjZEOm9ArpsWpnp37Tl5a\\nYfm5/6ybSx3X7B57F1PxIqQILT0xSeuyXSiXdRPJesot0Un8/U9SWW7vSiYq4ibA\\nwvivfHtouj93yaMWdLlqodUCAwEAAQ==\\n-----END PUBLIC KEY-----\",\n \"implementationType\" : \"TERRAFORM\",\n \"restriction\" : \"PRIVATE\",\n \"isSelfHosted\" : true,\n \"workloadIdentityFederation\" : {\n \"issuer\" : \"https://oidc.example.com\",\n \"subject\" : \"system:serviceaccount:meshfed:my-runner\",\n \"gcp\" : {\n \"audience\" : \"//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/my-provider\",\n \"tokenPath\" : \"/var/run/secrets/workload-identity/gcp/token\"\n },\n \"aws\" : {\n \"audience\" : \"sts.amazonaws.com\",\n \"tokenPath\" : \"/var/run/secrets/workload-identity/aws/token\"\n },\n \"azure\" : {\n \"audience\" : \"api://AzureADTokenExchange\",\n \"tokenPath\" : \"/var/run/secrets/workload-identity/azure/token\"\n }\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockrunners/00aab55a-fb6e-4e0b-8aaf-65021d4a973e\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockruns": {
"get": {
"tags": [
"Building Block Runs"
],
"summary": "List building block runs",
"description": "List meshBuildingBlockRuns for a specific building block with pagination support.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunList",
"parameters": [
{
"name": "buildingBlockUuid",
"in": "query",
"description": "Filter runs to the building block with the given UUID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunList"
},
"examples": {
"meshBuildingBlockRunList": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlockRuns\" : [ {\n \"kind\" : \"meshBuildingBlockRun\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"54294ba4-6b6e-4321-b5b6-ea29c4bf610a\"\n },\n \"spec\" : {\n \"runNumber\" : 1,\n \"buildingBlock\" : {\n \"uuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"spec\" : {\n \"displayName\" : \"block\",\n \"workspaceIdentifier\" : \"my-workspace\",\n \"projectIdentifier\" : \"my-project\",\n \"fullPlatformIdentifier\" : \"my-platform.my-location\",\n \"inputs\" : [ {\n \"key\" : \"input-1\",\n \"value\" : \"test\",\n \"type\" : \"STRING\",\n \"isSensitive\" : false,\n \"isEnvironment\" : false\n } ],\n \"parentBuildingBlocks\" : [ ]\n }\n },\n \"buildingBlockDefinition\" : {\n \"uuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"spec\" : {\n \"workspaceIdentifier\" : \"my-workspace\",\n \"version\" : 1,\n \"implementation\" : {\n \"type\" : \"TERRAFORM\",\n \"terraformVersion\" : \"v1\",\n \"repositoryUrl\" : \"https://example.com\",\n \"async\" : true,\n \"useMeshHttpBackendFallback\" : false\n }\n }\n },\n \"behavior\" : \"APPLY\",\n \"runToken\" : \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJPdXJGaUduQnB2QlZNY2NBRjVNT1J3bTA3ODRObHZHRlFXSjlmdm8wTklzIn0.eyJleHAiOjE3ODA0OTU2MzEsImlhdCI6MTc4MDQ5NTUxMiwianRpIjoidHJydGNjOjhjMGZjMGU5LTNiMDQtODQwMC0wNzhiLTAxZWM3YWIyYWQzYSIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NTA1MC9hdXRoL3JlYWxtcy9tZXNoZmVkIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQyNzc0OTI1LWQxY2EtNDUxYi1iZTVkLWNiNjYyZWQwMTlhNyIsInR5cCI6IkJlYXJlciIsImF6cCI6IjM2NDVlNDU2LTdiNGItNDM4Mi04Y2EwLTZkMDg1YWU3NGJmYyIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLW1lc2hmZWQiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImNsaWVudEhvc3QiOiIxMjcuMC4wLjEiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByZWZlcnJlZF91c2VybmFtZSI6InNlcnZpY2UtYWNjb3VudC0zNjQ1ZTQ1Ni03YjRiLTQzODItOGNhMC02ZDA4NWFlNzRiZmMiLCJjbGllbnRBZGRyZXNzIjoiMTI3LjAuMC4xIiwiY2xpZW50X2lkIjoiMzY0NWU0NTYtN2I0Yi00MzgyLThjYTAtNmQwODVhZTc0YmZjIn0.HthkyxKG2kbVsnBSOQd-LIHKkGv_SV-_WTWIVnyRzFvtjgreGr_YsMyz4tNxPK8GsxHkBalFFORxdiUz_9S-UYgfj5wV7wK2Bth8YLeuJrerHBkQvevuoFh4JgLqvMnSuqbgDmlpW90fdGRqdlO4KRgYrFcs4tX6B33VQkTTZQoQThmljPmlCBA1L0CEKIFp_cPJhS46zHS7hwnM2eKPXQuen3ymMz3SB7B4xerrg3qrGaPkvz6oMSPXmIKxsqxkiCQSZjsOtXPFakBSEoh9mO7Bo1bPGw0V1uRcvJUEqNa5-NIubfZ1b1qq8MNQS8h6hlKccoUYj-K0KIH7eNgb6w\"\n },\n \"status\" : \"IN_PROGRESS\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a\"\n },\n \"downloadLogs\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/logs\"\n },\n \"registerSource\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/status/source\"\n },\n \"updateSource\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/status/source/{sourceId}\",\n \"templated\" : true\n },\n \"meshstackBaseUrl\" : {\n \"href\" : \"https://mesh-backend-url\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns?buildingBlockUuid=68ce5455-2a4a-4a4b-a324-6a6c18cab85a&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblocks": {
"get": {
"tags": [
"Building Blocks"
],
"summary": "List building blocks",
"description": "List all meshBuildingBlocks with optional filtering by workspace, tenant, and pagination support\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockList",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for Building Blocks that belong to the meshWorkspace with given identifier. These are all Building Blocks that either belong directly to the meshWorkspace or to any meshTenant of one of the its meshProjects. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "projectIdentifier",
"in": "query",
"description": "Filter for Building Blocks that belong to the meshProject with given identifier. The result will only contain Building Blocks on tenant level. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "platformIdentifier",
"in": "query",
"description": "Filter for Building Blocks that belong to the meshPlatform with given identifier. The result will only contain Building Blocks on tenant level. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "Filter for Building Blocks with the given display name. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "definitionUuid",
"in": "query",
"description": "Filter for Building Blocks that belong to the definition with the given uuid. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "versionUuid",
"in": "query",
"description": "Filter for Building Blocks that belong to the definition version with the given uuid. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tenantUuid",
"in": "query",
"description": "Filter for Building Blocks that belong to the meshTenant with the given uuid. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "targetRefKind",
"in": "query",
"description": "Filter for Building Blocks that belong to a target of given kind. Must be either 'meshTenant' or 'meshWorkspace'. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "Filter for Building Blocks that have a certain status. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managedByWorkspaceIdentifier",
"in": "query",
"description": "Lists Building Blocks that are managed by the workspace with given identifier. Requires API key permission 'List all Building Blocks for owned definition'. Takes precedence over the 'managedByDefinitionUuid' parameter. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "managedByDefinitionUuid",
"in": "query",
"description": "Lists Building Blocks that are created based on the definition with given uuid. Requires API key permission 'List all Building Blocks for owned definition'. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "definitionName",
"in": "query",
"description": "Filter for Building Blocks that belong to the definition with the given name. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "query",
"description": "Filter for Building Blocks that use a certain version number. Can be the number or only 'v1', etc. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockListV2"
},
"examples": {
"meshBuildingBlockListV2": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlocks\" : [ {\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v2-preview\",\n \"metadata\" : {\n \"uuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"ownedByWorkspace\" : \"my-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\" : {\n \"uuid\" : \"53e26716-131d-4ca5-8ee6-e25f35f0d593\",\n \"kind\" : \"meshBuildingBlockDefinitionVersion\"\n },\n \"targetRef\" : {\n \"uuid\" : \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\",\n \"kind\" : \"meshTenant\"\n },\n \"displayName\" : \"parent block\",\n \"inputs\" : { },\n \"parentBuildingBlocks\" : [ ]\n },\n \"status\" : {\n \"status\" : \"SUCCEEDED\",\n \"outputs\" : { },\n \"forcePurge\" : false,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:13.261117481Z\"\n }\n },\n \"_links\" : {\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/68ce5455-2a4a-4a4b-a324-6a6c18cab85a\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/68ce5455-2a4a-4a4b-a324-6a6c18cab85a/purge\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v2-preview\",\n \"metadata\" : {\n \"uuid\" : \"5646eafe-5d56-43e5-84fe-329bb050d720\",\n \"ownedByWorkspace\" : \"my-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\" : {\n \"uuid\" : \"63f13d8f-aeee-4099-a042-abaea7ecb059\",\n \"kind\" : \"meshBuildingBlockDefinitionVersion\"\n },\n \"targetRef\" : {\n \"uuid\" : \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\",\n \"kind\" : \"meshTenant\"\n },\n \"displayName\" : \"child block\",\n \"inputs\" : {\n \"resourceName\" : {\n \"value\" : \"My Test Resource\",\n \"valueType\" : \"STRING\",\n \"isSensitive\" : false,\n \"assignmentType\" : \"USER_INPUT\",\n \"updateableByConsumer\" : false\n }\n },\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"SUCCEEDED\",\n \"outputs\" : {\n \"resourceId\" : {\n \"value\" : \"id-123\",\n \"valueType\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n }\n },\n \"latestRunUuid\" : \"8d78a427-f31d-4005-a0ad-fce2fd0652a5\",\n \"forcePurge\" : false,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:13.269320880Z\"\n }\n },\n \"_links\" : {\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720/purge\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks?projectIdentifier=my-project&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockList"
},
"examples": {
"meshBuildingBlockList": {
"value": "{\n \"_embedded\" : {\n \"meshBuildingBlocks\" : [ {\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"definitionVersion\" : 1,\n \"tenantIdentifier\" : \"my-workspace.my-project.my-platform.my-location\",\n \"forcePurge\" : false,\n \"createdOn\" : \"2026-06-03T14:05:09.102209235Z\"\n },\n \"spec\" : {\n \"displayName\" : \"parent block\",\n \"inputs\" : [ ],\n \"parentBuildingBlocks\" : [ ]\n },\n \"status\" : {\n \"status\" : \"SUCCEEDED\",\n \"outputs\" : [ ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/68ce5455-2a4a-4a4b-a324-6a6c18cab85a\"\n },\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/68ce5455-2a4a-4a4b-a324-6a6c18cab85a/purge\"\n }\n }\n }, {\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"5646eafe-5d56-43e5-84fe-329bb050d720\",\n \"definitionUuid\" : \"ef6aaf87-3f8c-477c-94f4-f3cf509728ca\",\n \"definitionVersion\" : 1,\n \"tenantIdentifier\" : \"my-workspace.my-project.my-platform.my-location\",\n \"forcePurge\" : false,\n \"createdOn\" : \"2026-06-03T14:05:09.124361364Z\"\n },\n \"spec\" : {\n \"displayName\" : \"child block\",\n \"inputs\" : [ {\n \"key\" : \"resourceName\",\n \"value\" : \"My Test Resource\",\n \"valueType\" : \"STRING\"\n } ],\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"SUCCEEDED\",\n \"outputs\" : [ {\n \"key\" : \"resourceId\",\n \"value\" : \"id-123\",\n \"valueType\" : \"STRING\"\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720\"\n },\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720/purge\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks?projectIdentifier=my-project&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Building Blocks"
],
"summary": "Create building block",
"description": "Create a new meshBuildingBlock with inputs and parent building block relationships\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockPost",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblocks-884287178"
},
"examples": {
"meshBuildingBlockPost": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshBuildingBlock\",\n \"metadata\" : {\n \"definitionUuid\" : \"ef6aaf87-3f8c-477c-94f4-f3cf509728ca\",\n \"definitionVersion\" : 1,\n \"tenantIdentifier\" : \"my-workspace.my-project.my-platform.my-location\"\n },\n \"spec\" : {\n \"displayName\" : \"New BuildingBlock\",\n \"inputs\" : [{\n \"key\": \"resourceName\",\n \"value\": \"buildingBlock-for-docs\",\n \"valueType\": \"STRING\"\n }],\n \"parentBuildingBlocks\" : [{\n \"definitionUuid\": \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"buildingBlockUuid\": \"74d41a62-300c-422e-bce7-6cef8b351618\"\n }]\n }\n} "
}
}
},
"application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblocks-uuid-836471433"
},
"examples": {
"meshBuildingBlockPostV2": {
"value": "{\n \"apiVersion\" : \"v2-preview\",\n \"kind\" : \"meshBuildingBlock\",\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\": {\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"uuid\": \"63f13d8f-aeee-4099-a042-abaea7ecb059\"\n },\n \"targetRef\": {\n \"kind\": \"meshTenant\",\n \"uuid\": \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\"\n },\n \"displayName\" : \"New BuildingBlock v2\",\n \"inputs\" : {\n \"resourceName\": {\n \"value\": \"buildingBlock-for-docs\",\n \"valueType\": \"STRING\"\n }\n },\n \"parentBuildingBlocks\" : [{\n \"definitionUuid\": \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"buildingBlockUuid\": \"9ea5cf31-6475-4489-b70b-74113d78ba83\"\n }]\n }\n} "
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockPost"
},
"examples": {
"meshBuildingBlockPost": {
"value": "{\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"3ce5aa18-869a-43c8-ab41-19b794ac76a0\",\n \"definitionUuid\" : \"ef6aaf87-3f8c-477c-94f4-f3cf509728ca\",\n \"definitionVersion\" : 1,\n \"tenantIdentifier\" : \"my-workspace.my-project.my-platform.my-location\",\n \"forcePurge\" : false,\n \"createdOn\" : \"2026-06-03T14:05:10.202376852Z\"\n },\n \"spec\" : {\n \"displayName\" : \"New BuildingBlock\",\n \"inputs\" : [ {\n \"key\" : \"resourceName\",\n \"value\" : \"buildingBlock-for-docs\",\n \"valueType\" : \"STRING\"\n } ],\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"74d41a62-300c-422e-bce7-6cef8b351618\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"PENDING\",\n \"outputs\" : [ ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/3ce5aa18-869a-43c8-ab41-19b794ac76a0\"\n },\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/3ce5aa18-869a-43c8-ab41-19b794ac76a0/purge\"\n }\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockPostV2"
},
"examples": {
"meshBuildingBlockPostV2": {
"value": "{\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v2-preview\",\n \"metadata\" : {\n \"uuid\" : \"db435958-06f1-472f-8c24-a82ba1ba2f6f\",\n \"ownedByWorkspace\" : \"my-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\" : {\n \"uuid\" : \"63f13d8f-aeee-4099-a042-abaea7ecb059\",\n \"kind\" : \"meshBuildingBlockDefinitionVersion\"\n },\n \"targetRef\" : {\n \"uuid\" : \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\",\n \"kind\" : \"meshTenant\"\n },\n \"displayName\" : \"New BuildingBlock v2\",\n \"inputs\" : {\n \"resourceName\" : {\n \"value\" : \"buildingBlock-for-docs\",\n \"valueType\" : \"STRING\",\n \"isSensitive\" : false,\n \"assignmentType\" : \"USER_INPUT\",\n \"updateableByConsumer\" : false\n }\n },\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"9ea5cf31-6475-4489-b70b-74113d78ba83\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"PENDING\",\n \"outputs\" : { },\n \"forcePurge\" : false,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:14.150666874Z\"\n }\n },\n \"_links\" : {\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/db435958-06f1-472f-8c24-a82ba1ba2f6f\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/db435958-06f1-472f-8c24-a82ba1ba2f6f/purge\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshcommunicationdefinitions": {
"get": {
"tags": [
"Communication Definitions"
],
"summary": "List communication definitions",
"description": "List all meshCommunicationDefinitions with optional filtering and pagination support.\n\n**Note**: the meshCommunication endpoint is still in preview mode, which means it is subject to change\nand we are planning to introduce a new version without support for backwards compatibility, meaning,\nthe preview version will disappear without prior warning! If this is not acceptable, please wait until\nthe final meshCommunication endpoints are announced in the release notes. These endpoints will be\nreleased in the next few weeks. From then on, we will provide backwards-compatible communication\nendpoints, meaning, once new versions are introduced, you can continue to use older versions\nby setting the correct Accept header.\n\nThe meshCommunication endpoints are only available if the developer portal module is activated\nin your meshStack. If you would like to enable this feature, please contact us at support@meshcloud.io\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationDefinitionList",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Filter by communication type. Example: `NOTIFICATION`.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshCommunicationDefinitionList"
},
"examples": {
"meshCommunicationDefinitionList": {
"value": "{\n \"_embedded\" : {\n \"meshCommunicationDefinitions\" : [ {\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"36bfc8d8-37ac-4513-979c-fb6970170dbf\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"Communication definition 1 Title\",\n \"message\" : \"Message for Communication definition 1. Use [this guide](http://example.com/1) for reference.\",\n \"dueDate\" : \"2026-06-04\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/36bfc8d8-37ac-4513-979c-fb6970170dbf\"\n }\n }\n }, {\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"8c2b4fe5-34d7-4463-908e-d48b2143d731\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"Communication definition 2 Title\",\n \"message\" : \"Message for Communication definition 2. Use [this guide](http://example.com/2) for reference.\",\n \"dueDate\" : \"2026-06-05\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/8c2b4fe5-34d7-4463-908e-d48b2143d731\"\n }\n }\n }, {\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"b7aa6025-1484-47ce-b3b2-83ad37bc0627\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"Communication definition 3 Title\",\n \"message\" : \"Message for Communication definition 3. Use [this guide](http://example.com/3) for reference.\",\n \"dueDate\" : \"2026-06-06\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/b7aa6025-1484-47ce-b3b2-83ad37bc0627\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions{?type}\",\n \"templated\" : true\n }\n },\n \"page\" : {\n \"size\" : 5,\n \"totalElements\" : 3,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
},
"meshCommunicationDefinitionListFilteredByType": {
"value": "{\n \"_embedded\" : {\n \"meshCommunicationDefinitions\" : [ {\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"8c2b4fe5-34d7-4463-908e-d48b2143d731\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"Communication definition 2 Title\",\n \"message\" : \"Message for Communication definition 2. Use [this guide](http://example.com/2) for reference.\",\n \"dueDate\" : \"2026-06-05\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/8c2b4fe5-34d7-4463-908e-d48b2143d731\"\n }\n }\n }, {\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"b7aa6025-1484-47ce-b3b2-83ad37bc0627\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"Communication definition 3 Title\",\n \"message\" : \"Message for Communication definition 3. Use [this guide](http://example.com/3) for reference.\",\n \"dueDate\" : \"2026-06-06\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/b7aa6025-1484-47ce-b3b2-83ad37bc0627\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions{?type}\",\n \"templated\" : true\n }\n },\n \"page\" : {\n \"size\" : 50,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Communication Definitions"
],
"summary": "Create communication definition",
"description": "Create a new meshCommunicationDefinition with the specified communication details.\nA meshCommunication is attached to a meshCommunicationDefinition, therefore,\na meshCommunicationDefinition must exist before you can create a meshCommunication.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationDefinitionPost",
"parameters": [
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json"
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshcommunicationdefinitions-1419667539"
},
"examples": {
"meshCommunicationDefinitionPost": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshCommunicationDefinition\",\n \"spec\": {\n \"communication\": {\n \"title\": \"Important Update\",\n \"message\": \"This is a test communication.\",\n \"type\": \"ACTION_REQUIRED\",\n \"dueDate\": \"2099-04-30\"\n }\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshCommunicationDefinitionPost"
},
"examples": {
"meshCommunicationDefinitionPost": {
"value": "{\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"b9e0ead6-d7f4-4fac-9231-691ad7a95fc6\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"Important Update\",\n \"message\" : \"This is a test communication.\",\n \"dueDate\" : \"2099-04-30\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/b9e0ead6-d7f4-4fac-9231-691ad7a95fc6\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshcommunications": {
"get": {
"tags": [
"Communications"
],
"summary": "List communications",
"description": "List all meshCommunications with optional filtering by definition, status, and type\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationList",
"parameters": [
{
"name": "communicationDefinitionUuid",
"in": "query",
"description": "Filter for communications that belong to the definition with the given uuid.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "resolutionStatus",
"in": "query",
"description": "Filter for communications with the given resolution status (OPEN, RESOLVED).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "communicationType",
"in": "query",
"description": "Filter for communications where the associated definition has the given communication type (ACTION_REQUIRED, NOTIFICATION).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "meshApi is versioned and you should use `application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json` as an `Accept` header to be guaranteed the V1 response format of this endpoint. New versions will be added in future.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshCommunicationList"
},
"examples": {
"meshCommunicationList": {
"value": "{\n \"_embedded\" : {\n \"meshCommunications\" : [ {\n \"kind\" : \"meshCommunication\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"c0475220-f157-4775-80f5-5e205e5e1163\",\n \"ownedByWorkspace\" : \"my-workspace-identifier\"\n },\n \"spec\" : {\n \"targetMeshObjectRef\" : {\n \"kind\" : \"meshWorkspace\",\n \"name\" : \"my-workspace-identifier\"\n },\n \"communicationDefinitionRef\" : {\n \"uuid\" : \"b0c0e088-cea8-4516-b989-553502018cc6\",\n \"kind\" : \"meshCommunicationDefinition\"\n }\n },\n \"status\" : {\n \"resolutionStatus\" : \"OPEN\",\n \"meshCommunicationDefinition\" : {\n \"uuid\" : \"b0c0e088-cea8-4516-b989-553502018cc6\",\n \"title\" : \"Communication definition 1 Title\",\n \"dueDate\" : \"2026-06-04\",\n \"communicationType\" : \"ACTION_REQUIRED\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunications/c0475220-f157-4775-80f5-5e205e5e1163\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunications?communicationDefinitionUuid=b0c0e088-cea8-4516-b989-553502018cc6&resolutionStatus=OPEN&communicationType=ACTION_REQUIRED&page=0&size=3\"\n }\n },\n \"page\" : {\n \"size\" : 3,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Communications"
],
"summary": "Create a new communication",
"description": "Create a new meshCommunication to initiate communication with mesh object owners\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationPost",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshcommunications-1284413466"
},
"examples": {
"meshCommunicationPost": {
"value": "{\n \"kind\": \"meshCommunication\",\n \"apiVersion\": \"v1-preview\",\n \"spec\": {\n \"targetMeshObjectRef\": {\n \"kind\": \"meshWorkspace\",\n \"name\": \"my-workspace-identifier\"\n },\n \"communicationDefinitionRef\": {\n \"uuid\": \"b0c0e088-cea8-4516-b989-553502018cc6\",\n \"kind\": \"meshCommunicationDefinition\"\n }\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshCommunicationPost"
},
"examples": {
"meshCommunicationPost": {
"value": "{\n \"kind\" : \"meshCommunication\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"c0475220-f157-4775-80f5-5e205e5e1163\",\n \"ownedByWorkspace\" : \"my-workspace-identifier\"\n },\n \"spec\" : {\n \"targetMeshObjectRef\" : {\n \"kind\" : \"meshWorkspace\",\n \"name\" : \"my-workspace-identifier\"\n },\n \"communicationDefinitionRef\" : {\n \"uuid\" : \"b0c0e088-cea8-4516-b989-553502018cc6\",\n \"kind\" : \"meshCommunicationDefinition\"\n }\n },\n \"status\" : {\n \"resolutionStatus\" : \"OPEN\",\n \"meshCommunicationDefinition\" : {\n \"uuid\" : \"b0c0e088-cea8-4516-b989-553502018cc6\",\n \"title\" : \"Communication definition 1 Title\",\n \"dueDate\" : \"2026-06-04\",\n \"communicationType\" : \"ACTION_REQUIRED\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunications/c0475220-f157-4775-80f5-5e205e5e1163\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/mesheventlogs": {
"get": {
"tags": [
"Event Logs"
],
"summary": "List all event logs",
"description": "Provides a paged list of meshEventLogs. This endpoint allows you to retrieve event logs\nfrom meshStack, which provide an audit trail of actions and changes within your workspaces.\n\nEvent logs are read-only and are automatically created by meshStack when significant actions\noccur, such as workspace creation, user assignments, or configuration changes.\n\n**Access Control:**\n- Admin users can access event logs across all workspaces\n- Regular users can only access event logs from their own workspace\n\n**Filtering:**\nYou can filter event logs by time range, event type, workspace, author, and text searches\non title and description fields.\n\nWhen filtering by time range using the `from` and `until` parameters, keep in mind that\nthe `until` timestamp is exclusive. This means only event logs created strictly before\nthe `until` timestamp are included in the results. For example, to retrieve all events\nfrom a specific day (e.g., May 29, 2025 UTC), set `from=2025-05-29T00:00:00Z` and\n`until=2025-05-30T00:00:00Z`. Avoid using values like `2025-05-29T23:59:59Z` for `until`,\nas this would exclude events created in the final milliseconds before midnight.\n\n\nThe `title` filter is suitable to filter events by their category. Click here for a list of all possible `title` values.
\n- API Key Changed\n- API Key Created\n- API Key Deleted\n- API User Changed\n- API User Created\n- API User Deleted\n- API User Password Rotated\n- Advisory Created\n- Advisory Resolved\n- Building Block Created\n- Building Block Definition Created\n- Building Block Definition Deleted\n- Building Block Definition Deprecated\n- Building Block Definition Marked For Deletion\n- Building Block Definition Marketplace Publication Request\n- Building Block Definition Marketplace Publication Request Approved\n- Building Block Definition Marketplace Publication Request Rejected\n- Building Block Definition Modified\n- Building Block Definition Ownership Transferred\n- Building Block Definition Reactivated\n- Building Block Definition Tags Edited\n- Building Block Definition Version Added\n- Building Block Definition Version Dependencies Modified\n- Building Block Definition Version Modified\n- Building Block Definition Version Published\n- Building Block Definition Version Released\n- Building Block Deleted\n- Building Block Deletion Requested\n- Building Block Run Executed\n- Building Block Run Requested\n- Building Block Runner Changed\n- Building Block Runner Created\n- Building Block Runner Deleted\n- Communication Created\n- Communication Definition Created\n- Communication Definition Deleted\n- Communication Definition Updated\n- Communication Deleted\n- Communication Resolved\n- Integration Changed\n- Integration Created\n- Integration Deleted\n- Landing Zone Configuration Changed\n- Landing Zone Created\n- Landing Zone Deleted\n- Landing Zone Name Changed\n- Landing Zone Settings Changed\n- Landing Zone Tags Changed\n- Payment Method Changed\n- Payment Method Created\n- Payment Method Deleted\n- Pipeline Changed\n- Platform Configuration Changed\n- Platform Created\n- Platform Deactivated\n- Platform Deleted\n- Platform Name Changed\n- Platform Ownership Transferred\n- Platform Price Changed\n- Platform Publication Request Approved\n- Platform Publication Request Rejected\n- Platform Publication Request Submitted\n- Platform Quota Added\n- Platform Quota Changed\n- Platform Quota Removed\n- Platform Reactivated\n- Platform Settings Changed\n- Policy Changed\n- Policy Created\n- Policy Deleted\n- Project Created\n- Project Deleted\n- Project Deletion Rejected\n- Project Deletion Request Submitted\n- Project Group Access Request Approved\n- Project Group Access Request Rejected\n- Project Group Access Request Submitted\n- Project Group Role Added\n- Project Group Role Changed\n- Project Group Role Expiration Date Changed\n- Project Group Role Removed\n- Project Name Changed\n- Project Payment Method Added\n- Project Payment Method Changed\n- Project Role Changed\n- Project Role Created\n- Project Role Deleted\n- Project Tags Changed\n- Project User Access Request Approved\n- Project User Access Request Rejected\n- Project User Access Request Submitted\n- Project User Role Added\n- Project User Role Changed\n- Project User Role Expiration Date Changed\n- Project User Role Removed\n- System Prompt Changed\n- System Prompt Created\n- System Prompt Deleted\n- Tag Definition Changed\n- Tag Definition Created\n- Tag Definition Deleted\n- Tenant Created\n- Tenant Deleted\n- Tenant Deletion Request Approved\n- Tenant Deletion Request Rejected\n- Tenant Deletion Request Submitted\n- Tenant Landing Zone Changed\n- Tenant Moved\n- Tenant Purge Request Submitted\n- Tenant Purged\n- User Changed\n- User Created\n- User Deleted\n- User Disabled\n- User Enabled\n- Workspace Created\n- Workspace Deleted\n- Workspace Group Access Request Approved\n- Workspace Group Access Request Rejected\n- Workspace Group Access Request Submitted\n- Workspace Group Members Added\n- Workspace Group Members Removed\n- Workspace Group Role Added\n- Workspace Group Role Changed\n- Workspace Group Role Expiration Date Changed\n- Workspace Group Role Removed\n- Workspace Name Changed\n- Workspace Quota Changed\n- Workspace Tags Changed\n- Workspace User Access Request Approved\n- Workspace User Access Request Rejected\n- Workspace User Access Request Submitted\n- Workspace User Role Added\n- Workspace User Role Changed\n- Workspace User Role Expiration Date Changed\n- Workspace User Role Removed\n \n\n:::tip[Limitation: Author Information]\n\nAuthor information on Event Logs is only tracked reliably for events created in Mid December 2025 or\nlater. For these events, the `authorType` and `authorIdentifier` query parameter works as you would\nexpect. For older events, the following limitations apply:\n\n1. In the response payload, these events have their `author.authorType` set to `Unknown`.\n2. The `authorType` query parameter must be left unspecified to obtain these events (do not set it\n to `Unknown`.\n3. There are inconsistencies regarding the `authorIdentifier`. For example, the `authorIdentifier`\n sometimes corresponds to an Api Key UUID and sometimes to an Api Key name.\n\nWe are planning to migrate historical event logs to improve author filtering and provide\naccurate author information for all events in the future.\n\n:::\n\n**Authentication:** This endpoint supports multiple authentication methods: API Key authentication or API User authentication.",
"operationId": "meshEventLogList",
"parameters": [
{
"name": "from",
"in": "query",
"description": "Filter for event logs created on or after this timestamp (ISO-8601 format). (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "until",
"in": "query",
"description": "Filter for event logs created *before* this timestamp (ISO-8601 format). event logs exactly at this timestamp will *not* be included. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "title",
"in": "query",
"description": "Filter for event logs with a title containing this text. All possible values are shown at the top of this page. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"description": "Filter for event logs with a description containing this text. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authorType",
"in": "query",
"description": "Filter for event logs by author type. Intended to be used together with authorIdentifier. Possible values: ApiKey, ApiUser, System, User. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "authorIdentifier",
"in": "query",
"description": "Filter for event logs by author identifier (optional). Intended be used together with authorType. Depending on the authorType, the authorIdentifier corresponds to:\n* ApiKey: The Key ID (UUID) of the ApiKey\n* ApiUser: The username of the ApiUser\n* System: Always `system` (only a single System author exists)\n* User: The `uuid` of the User",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "eventType",
"in": "query",
"description": "Filter for event logs of a specific type. Possible values: Added, Approved, Cancelled, Changed, Created, Deleted, Rejected, Removed, Requested. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceName",
"in": "query",
"description": "Filter for event logs associated with a specific workspace name (optional). Notice that the `workspaceName` filter does *not* correspond to the `spec.workspaceRef.name` from the response payload: `spec.workspaceRef.name` is the workspace identifier. This filter performs a partial match on the workspace display name. Cannot be combined with `workspaceIdentifier`.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for event logs associated with a specific workspace identifier (optional). This filter requires an exact match on the workspace identifier, which corresponds to `spec.workspaceRef.name` in the response payload. Cannot be combined with `workspaceName`.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "excludeTitle",
"in": "query",
"description": "Exclude event logs with the specified title. Can be specified multiple times to exclude multiple titles. Useful for filtering out high-volume event types. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.mesheventlog.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshEventLogList"
},
"examples": {
"meshEventLogList": {
"value": "{\n \"_embedded\" : {\n \"meshEventLogs\" : [ {\n \"kind\" : \"meshEventLog\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"a4eba1b1-d635-4fc5-b3f6-c656373774f3\",\n \"createdAt\" : \"2024-01-15T10:30:00Z\"\n },\n \"spec\" : {\n \"title\" : \"Workspace Name Changed\",\n \"eventType\" : \"Changed\",\n \"description\" : \"Workspace Workspace ABC was changed to Workspace XYZ\",\n \"workspaceRef\" : {\n \"name\" : \"my-workspace\",\n \"kind\" : \"meshWorkspace\"\n },\n \"content\" : {\n \"name\" : \"Workspace XYZ\"\n },\n \"previousContent\" : {\n \"name\" : \"Workspace ABC\"\n },\n \"author\" : {\n \"authorType\" : \"System\",\n \"identifier\" : \"system\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/mesheventlogs/a4eba1b1-d635-4fc5-b3f6-c656373774f3\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/mesheventlogs?workspaceName=my-workspace&page=0&size=1&sort=id,asc\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/mesheventlogs?workspaceName=my-workspace&page=0&size=1\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/mesheventlogs?workspaceName=my-workspace&page=1&size=1&sort=id,asc\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/mesheventlogs?workspaceName=my-workspace&page=1&size=1&sort=id,asc\"\n }\n },\n \"page\" : {\n \"size\" : 1,\n \"totalElements\" : 2,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
},
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshintegrations": {
"get": {
"tags": [
"Integrations"
],
"summary": "List integrations",
"description": "List all integrations accessible by the user with optional pagination and filtering.\n\nIntegrations enable building blocks to interact with external systems like GitHub, GitLab,\nand Azure DevOps for pipeline automation and repository management.\n\nmeshStack provides two built-in integrations:\n- **meshStack Replicator (Built-in)**: System integration for the meshStack Replicator component\n- **meshStack Metering (Built-in)**: System integration for the meshStack Metering/Kraken component\n\nBuilt-in integrations are:\n- Read-only (cannot be created, updated, or deleted via the API)\n- Visible to all users with the list permission for integrations\n- Include a `status` field with Workload Identity Federation (WIF) information for cloud provider authentication\n\nRegular (user-created) integrations do not provide the `WIF` information and can be fully managed via the API.\n\nUsers can only see integrations that belong to their workspace (workspace-scoped access) plus the built-in integrations.\nPlatform administrators can see all integrations across all workspaces.\n\nThe response includes pagination information and HAL links for navigation.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshIntegration-List",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "displayName",
"in": "query",
"description": "Filter integrations by display name (exact match)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ownedByWorkspace",
"in": "query",
"description": "Filter integrations by workspace identifier",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Filter integrations by type. This includes user-created integration types as well as built-in integration types.\n\nAll available types: GITLAB, GITHUB, AZURE_DEVOPS, ENTRA_ID, REPLICATOR, METERING",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshintegration.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshintegration.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshIntegration-List"
},
"examples": {
"meshIntegration-List": {
"value": "{\n \"_embedded\" : {\n \"meshIntegrations\" : [ {\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"c8f4e7d2-3b1a-4c9e-8d5f-6a2b7c8d9e0f\",\n \"ownedByWorkspace\" : \"admin-customer\"\n },\n \"spec\" : {\n \"displayName\" : \"meshStack Replicator (Built-in)\",\n \"config\" : {\n \"type\" : \"replicator\"\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:04:35Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : true,\n \"workloadIdentityFederation\" : {\n \"issuer\" : \"https://container.googleapis.com/v1/projects/meshcloud-meshcloud--bc0/locations/europe-west1/clusters/meshstacks-ha\",\n \"subject\" : \"system:serviceaccount:meshcloud-dev:replicator\",\n \"gcp\" : {\n \"audience\" : \"gcp-workload-identity-provider:meshcloud-dev\"\n },\n \"aws\" : {\n \"audience\" : \"aws-workload-identity-provider:meshcloud-dev\",\n \"thumbprint\" : \"08745487e891c19e3078c1f2a07e452950ef36f6\"\n },\n \"azure\" : {\n \"audience\" : \"api://AzureADTokenExchange\"\n }\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/c8f4e7d2-3b1a-4c9e-8d5f-6a2b7c8d9e0f\"\n }\n }\n }, {\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"ownedByWorkspace\" : \"admin-customer\"\n },\n \"spec\" : {\n \"displayName\" : \"meshStack Metering (Built-in)\",\n \"config\" : {\n \"type\" : \"metering\"\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:04:35Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : true,\n \"workloadIdentityFederation\" : {\n \"issuer\" : \"https://container.googleapis.com/v1/projects/meshcloud-meshcloud--bc0/locations/europe-west1/clusters/meshstacks-ha\",\n \"subject\" : \"system:serviceaccount:meshcloud-dev:kraken-worker\",\n \"gcp\" : {\n \"audience\" : \"gcp-workload-identity-provider:meshcloud-dev\"\n },\n \"aws\" : {\n \"audience\" : \"aws-workload-identity-provider:meshcloud-dev\",\n \"thumbprint\" : \"08745487e891c19e3078c1f2a07e452950ef36f6\"\n },\n \"azure\" : {\n \"audience\" : \"api://AzureADTokenExchange\"\n }\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\"\n }\n }\n }, {\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My GitHub Integration\",\n \"config\" : {\n \"type\" : \"github\",\n \"github\" : {\n \"owner\" : \"my-org\",\n \"baseUrl\" : \"https://api.github.com\",\n \"appId\" : \"123456\",\n \"appPrivateKey\" : {\n \"hash\" : \"sha256:1e179003f0dee1c9ebbacbb338a9bff5955deefa173d81098ee7538d9caacb1f\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:17.906538732Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\"\n }\n }\n }, {\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"6125e767-d378-4b7f-8a3c-a1ea4676470b\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My GitLab Integration\",\n \"config\" : {\n \"type\" : \"gitlab\",\n \"gitlab\" : {\n \"baseUrl\" : \"https://gitlab.com\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.088175496Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/6125e767-d378-4b7f-8a3c-a1ea4676470b\"\n }\n }\n }, {\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"fe419510-0160-4a41-8a52-3a39a7deacd0\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My Azure DevOps Integration\",\n \"config\" : {\n \"type\" : \"azuredevops\",\n \"azuredevops\" : {\n \"baseUrl\" : \"https://dev.azure.com\",\n \"organization\" : \"my-org\",\n \"personalAccessToken\" : {\n \"hash\" : \"sha256:bce51f31dfa49b76a306a7bac2b0295a8d1575db3c5e4c1e3ae6d575d8c6f50d\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.262998971Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/fe419510-0160-4a41-8a52-3a39a7deacd0\"\n }\n }\n }, {\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"4da7cb74-4291-483a-9407-7b047b172076\",\n \"ownedByWorkspace\" : \"demo-partner\"\n },\n \"spec\" : {\n \"displayName\" : \"My Entra ID Integration\",\n \"config\" : {\n \"type\" : \"entraid\",\n \"entraid\" : {\n \"tenantId\" : \"test-tenant-id\",\n \"clientId\" : \"test-client-id\",\n \"clientSecret\" : {\n \"hash\" : \"sha256:43a620a568e4f42f75cae5cbd74335924efc51874ba5cb765834571a7816da21\"\n },\n \"redirectUrl\" : \"http://localhost:5050/auth/realms/meshfed/broker/idp-integration-4da7cb74-4291-483a-9407-7b047b172076/endpoint\"\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.438048576Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/4da7cb74-4291-483a-9407-7b047b172076\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations?page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 6,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Integrations"
],
"summary": "Create an integration",
"description": "Create a new integration. You can create integrations for different integration types such as\nGitHub or Azure DevOps. For each of these types, specific configuration fields are required.\n\nThe integration will be owned by the workspace specified in metadata.ownedByWorkspace.\nUsers can only create integrations for their own workspace unless they have admin permissions.\n\nSecrets in the integration configurations will be encrypted and stored securely. When retrieving\nthe integration, these fields are returned with a hash value instead of the actual secret, enabling\ndrift detection while maintaining security.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshIntegration-Post-",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshintegration.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshintegration.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshintegration.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshintegrations-168845288"
},
"examples": {
"meshIntegration-Post-entra_id": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"ownedByWorkspace\": \"demo-partner\"\n },\n \"spec\": {\n \"displayName\": \"My Entra ID Integration\",\n \"config\": {\n \"type\": \"entraid\",\n \"entraid\": {\n \"tenantId\": \"test-tenant-id\",\n \"clientId\": \"test-client-id\",\n \"clientSecret\": {\n \"plaintext\": \"test-secret\"\n }\n }\n }\n }\n}"
},
"meshIntegration-Post-azure_devops": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"My Azure DevOps Integration\",\n \"config\": {\n \"type\": \"azuredevops\",\n \"azuredevops\": {\n \"baseUrl\": \"https://dev.azure.com\",\n \"organization\": \"my-org\",\n \"personalAccessToken\": {\n \"plaintext\": \"test-pat-token\"\n },\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"05cfa85f-2818-4bdd-b193-620e0187d7de\"\n }\n }\n }\n }\n}"
},
"meshIntegration-Post-github": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"My GitHub Integration\",\n \"config\": {\n \"type\": \"github\",\n \"github\": {\n \"owner\": \"my-org\",\n \"baseUrl\": \"https://api.github.com\",\n \"appId\": \"123456\",\n \"appPrivateKey\": {\n \"plaintext\": \"test-private-key\"\n },\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\"\n }\n }\n }\n }\n}"
},
"meshIntegration-Post-gitlab": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"My GitLab Integration\",\n \"config\": {\n \"type\": \"gitlab\",\n \"gitlab\": {\n \"baseUrl\": \"https://gitlab.com\",\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\"\n }\n }\n }\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshintegration.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshIntegration-Post-entra_id"
},
"examples": {
"meshIntegration-Post-entra_id": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"4da7cb74-4291-483a-9407-7b047b172076\",\n \"ownedByWorkspace\" : \"demo-partner\"\n },\n \"spec\" : {\n \"displayName\" : \"My Entra ID Integration\",\n \"config\" : {\n \"type\" : \"entraid\",\n \"entraid\" : {\n \"tenantId\" : \"test-tenant-id\",\n \"clientId\" : \"test-client-id\",\n \"clientSecret\" : {\n \"hash\" : \"sha256:43a620a568e4f42f75cae5cbd74335924efc51874ba5cb765834571a7816da21\"\n },\n \"redirectUrl\" : \"http://localhost:5050/auth/realms/meshfed/broker/idp-integration-4da7cb74-4291-483a-9407-7b047b172076/endpoint\"\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.438048576Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/4da7cb74-4291-483a-9407-7b047b172076\"\n }\n }\n}"
},
"meshIntegration-Post-azure_devops": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"fe419510-0160-4a41-8a52-3a39a7deacd0\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My Azure DevOps Integration\",\n \"config\" : {\n \"type\" : \"azuredevops\",\n \"azuredevops\" : {\n \"baseUrl\" : \"https://dev.azure.com\",\n \"organization\" : \"my-org\",\n \"personalAccessToken\" : {\n \"hash\" : \"sha256:bce51f31dfa49b76a306a7bac2b0295a8d1575db3c5e4c1e3ae6d575d8c6f50d\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.262998971Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/fe419510-0160-4a41-8a52-3a39a7deacd0\"\n }\n }\n}"
},
"meshIntegration-Post-github": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My GitHub Integration\",\n \"config\" : {\n \"type\" : \"github\",\n \"github\" : {\n \"owner\" : \"my-org\",\n \"baseUrl\" : \"https://api.github.com\",\n \"appId\" : \"123456\",\n \"appPrivateKey\" : {\n \"hash\" : \"sha256:1e179003f0dee1c9ebbacbb338a9bff5955deefa173d81098ee7538d9caacb1f\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:17.906538732Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\"\n }\n }\n}"
},
"meshIntegration-Post-gitlab": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"6125e767-d378-4b7f-8a3c-a1ea4676470b\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My GitLab Integration\",\n \"config\" : {\n \"type\" : \"gitlab\",\n \"gitlab\" : {\n \"baseUrl\" : \"https://gitlab.com\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.088175496Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/6125e767-d378-4b7f-8a3c-a1ea4676470b\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshlandingzones": {
"get": {
"tags": [
"Landing Zones"
],
"summary": "List landing zones",
"description": "List all meshLandingZones with pagination support. Filter options use exact equals matching (not fuzzy search).\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLandingZone-List",
"parameters": [
{
"name": "identifier",
"in": "query",
"description": "Filter by landing zone identifier (provided in the metadata.name field).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "displayName",
"in": "query",
"description": "Filter by landing zone display name.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "platformUuid",
"in": "query",
"description": "Filter by UUID of the platform instance the landing zone belongs to.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycleState",
"in": "query",
"description": "Filter by lifecycle state (ACTIVE, DEACTIVATED). Can be specified multiple times to include multiple states (OR logic). When not specified, returns ACTIVE and DEACTIVATED landing zones. Note: Landing zones cannot be deleted, only deactivated.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "restricted",
"in": "query",
"description": "Filter by restricted status (true for restricted landing zones, false for unrestricted ones).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ownedByWorkspace",
"in": "query",
"description": "Filter by workspace identifier that owns the landing zone.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlandingzone.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshlandingzone.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLandingZone-List"
},
"examples": {
"meshLandingZone-List": {
"value": "{\n \"_embedded\" : {\n \"meshLandingZones\" : [ {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aks\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new aks landing zone for testing\",\n \"displayName\" : \"New Landing Zone aks\",\n \"platformRef\" : {\n \"uuid\" : \"a32a9277-f6d3-4a09-9083-5ca8d43831c9\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aks\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/a32a9277-f6d3-4a09-9083-5ca8d43831c9\"\n }\n }\n }, {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aws\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new aws landing zone for testing\",\n \"displayName\" : \"New Landing Zone aws\",\n \"platformRef\" : {\n \"uuid\" : \"23ffc575-4670-4379-879a-25effbea544b\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"awsTargetOrgUnitId\" : \"ou-lpzq-kmf17bec\",\n \"awsEnrollAccount\" : true,\n \"awsLambdaArn\" : \"arn:aws:lambda:us-east-1:123456789012:function:MyLambdaFunction\",\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRole\" : \"AwsSpecificRole\",\n \"policies\" : [ \"arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aws\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/23ffc575-4670-4379-879a-25effbea544b\"\n }\n }\n }, {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azure\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new azure landing zone for testing\",\n \"displayName\" : \"New Landing Zone azure\",\n \"platformRef\" : {\n \"uuid\" : \"5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"azureManagementGroupId\" : \"azure-management-group\",\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"8c91d80b-141a-444a-b51c-4217c7384250\"\n },\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"admin\",\n \"azureRoleDefinitions\" : [ {\n \"azureRoleDefinitionId\" : \"c5935d7e-37b2-4f34-af8f-bdca2408296e\"\n } ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azure\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\"\n }\n }\n }, {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azurerg\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new azurerg landing zone for testing\",\n \"displayName\" : \"New Landing Zone azurerg\",\n \"platformRef\" : {\n \"uuid\" : \"e659bb60-3764-46b3-a4a2-5d82fcd1792d\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"azureRgLocation\" : \"eastus2\",\n \"azureRgRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"owner\",\n \"azureRoleDefinitionIds\" : [ \"fd876abe-603d-44d2-bf8a-067bbeacd485\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"reader\",\n \"azureRoleDefinitionIds\" : [ \"39a5f86f-a2d0-459d-b4eb-f536464933d0\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"user\",\n \"azureRoleDefinitionIds\" : [ \"492334bd-d0fd-4724-9270-e55495c2d88e\" ]\n } ],\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"78f9140e-1f7c-45a1-a633-3f1b92df362bn\"\n }\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azurerg\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/e659bb60-3764-46b3-a4a2-5d82fcd1792d\"\n }\n }\n }, {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-custom\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new custom landing zone for testing\",\n \"displayName\" : \"New Landing Zone custom\",\n \"platformRef\" : {\n \"uuid\" : \"5c4082eb-84d2-48d5-9804-ba3f8e2fd563\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"custom\",\n \"custom\" : { }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-custom\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c4082eb-84d2-48d5-9804-ba3f8e2fd563\"\n }\n }\n }, {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-gcp\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new gcp landing zone for testing\",\n \"displayName\" : \"New Landing Zone gcp\",\n \"platformRef\" : {\n \"uuid\" : \"8de142b8-8626-4eef-83a0-e99acf05fad2\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"gcpFolderId\" : \"12345\",\n \"gcpTemplateUrl\" : \"gs://my-bucket-name/folder/template\",\n \"gcpCloudFunctionUrl\" : \"https://us-central1-my-sample-project.cloudfunctions.net/helloWorld\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/owner\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\", \"roles/viewer\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-gcp\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/8de142b8-8626-4eef-83a0-e99acf05fad2\"\n }\n }\n }, {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-kubernetes\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new kubernetes landing zone for testing\",\n \"displayName\" : \"New Landing Zone kubernetes\",\n \"platformRef\" : {\n \"uuid\" : \"707ec5a2-426f-4087-8b37-2c67f10abddd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-kubernetes\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/707ec5a2-426f-4087-8b37-2c67f10abddd\"\n }\n }\n }, {\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-openshift\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new openshift landing zone for testing\",\n \"displayName\" : \"New Landing Zone openshift\",\n \"platformRef\" : {\n \"uuid\" : \"1f1d4e84-d0ca-4d85-9e30-1f54849824bd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"openshift\",\n \"openshift\" : { }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-openshift\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/1f1d4e84-d0ca-4d85-9e30-1f54849824bd\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones?page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 8,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Landing Zones"
],
"summary": "Create landing zone",
"description": "Create a new meshLandingZone\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLandingZone-Post-",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlandingzone.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlandingzone.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshlandingzone.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshlandingzones-879138272"
},
"examples": {
"meshLandingZone-Post-azure": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azure\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone azure\",\n \"description\" : \"A new azure landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"azureManagementGroupId\" : \"azure-management-group\",\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"8c91d80b-141a-444a-b51c-4217c7384250\"\n },\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"admin\",\n \"azureRoleDefinitions\" : [ {\n \"azureRoleDefinitionId\" : \"c5935d7e-37b2-4f34-af8f-bdca2408296e\",\n \"abacCondition\" : null\n } ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Post-openshift": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-openshift\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone openshift\",\n \"description\" : \"A new openshift landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"1f1d4e84-d0ca-4d85-9e30-1f54849824bd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"openshift\",\n \"openshift\" : { }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ]\n }\n}"
},
"meshLandingZone-Post-aks": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aks\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone aks\",\n \"description\" : \"A new aks landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"a32a9277-f6d3-4a09-9083-5ca8d43831c9\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ]\n }\n}"
},
"meshLandingZone-Post-kubernetes": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-kubernetes\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone kubernetes\",\n \"description\" : \"A new kubernetes landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"707ec5a2-426f-4087-8b37-2c67f10abddd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ]\n }\n}"
},
"meshLandingZone-Post-aws": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aws\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone aws\",\n \"description\" : \"A new aws landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"23ffc575-4670-4379-879a-25effbea544b\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"awsTargetOrgUnitId\" : \"ou-lpzq-kmf17bec\",\n \"awsEnrollAccount\" : true,\n \"awsLambdaArn\" : \"arn:aws:lambda:us-east-1:123456789012:function:MyLambdaFunction\",\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRole\" : \"AwsSpecificRole\",\n \"policies\" : [ \"arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Post-gcp": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-gcp\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone gcp\",\n \"description\" : \"A new gcp landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"8de142b8-8626-4eef-83a0-e99acf05fad2\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"gcpFolderId\" : \"12345\",\n \"gcpTemplateUrl\" : \"gs://my-bucket-name/folder/template\",\n \"gcpCloudFunctionUrl\" : \"https://us-central1-my-sample-project.cloudfunctions.net/helloWorld\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/owner\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\", \"roles/viewer\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Post-custom": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-custom\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone custom\",\n \"description\" : \"A new custom landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"5c4082eb-84d2-48d5-9804-ba3f8e2fd563\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"custom\",\n \"custom\" : { }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Post-azurerg": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azurerg\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"New Landing Zone azurerg\",\n \"description\" : \"A new azurerg landing zone for testing\",\n \"platformRef\" : {\n \"uuid\" : \"e659bb60-3764-46b3-a4a2-5d82fcd1792d\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"azureRgLocation\" : \"eastus2\",\n \"azureRgRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"owner\",\n \"azureRoleDefinitionIds\" : [ \"fd876abe-603d-44d2-bf8a-067bbeacd485\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"reader\",\n \"azureRoleDefinitionIds\" : [ \"39a5f86f-a2d0-459d-b4eb-f536464933d0\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"user\",\n \"azureRoleDefinitionIds\" : [ \"492334bd-d0fd-4724-9270-e55495c2d88e\" ]\n } ],\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"78f9140e-1f7c-45a1-a633-3f1b92df362bn\"\n }\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshlandingzone.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLandingZone-Post-azure"
},
"examples": {
"meshLandingZone-Post-azure": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azure\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new azure landing zone for testing\",\n \"displayName\" : \"New Landing Zone azure\",\n \"platformRef\" : {\n \"uuid\" : \"5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"azureManagementGroupId\" : \"azure-management-group\",\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"8c91d80b-141a-444a-b51c-4217c7384250\"\n },\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"admin\",\n \"azureRoleDefinitions\" : [ {\n \"azureRoleDefinitionId\" : \"c5935d7e-37b2-4f34-af8f-bdca2408296e\"\n } ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azure\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\"\n }\n }\n}"
},
"meshLandingZone-Post-openshift": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-openshift\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new openshift landing zone for testing\",\n \"displayName\" : \"New Landing Zone openshift\",\n \"platformRef\" : {\n \"uuid\" : \"1f1d4e84-d0ca-4d85-9e30-1f54849824bd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"openshift\",\n \"openshift\" : { }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-openshift\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/1f1d4e84-d0ca-4d85-9e30-1f54849824bd\"\n }\n }\n}"
},
"meshLandingZone-Post-aks": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aks\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new aks landing zone for testing\",\n \"displayName\" : \"New Landing Zone aks\",\n \"platformRef\" : {\n \"uuid\" : \"a32a9277-f6d3-4a09-9083-5ca8d43831c9\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aks\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/a32a9277-f6d3-4a09-9083-5ca8d43831c9\"\n }\n }\n}"
},
"meshLandingZone-Post-kubernetes": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-kubernetes\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new kubernetes landing zone for testing\",\n \"displayName\" : \"New Landing Zone kubernetes\",\n \"platformRef\" : {\n \"uuid\" : \"707ec5a2-426f-4087-8b37-2c67f10abddd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 4\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-kubernetes\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/707ec5a2-426f-4087-8b37-2c67f10abddd\"\n }\n }\n}"
},
"meshLandingZone-Post-aws": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aws\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new aws landing zone for testing\",\n \"displayName\" : \"New Landing Zone aws\",\n \"platformRef\" : {\n \"uuid\" : \"23ffc575-4670-4379-879a-25effbea544b\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"awsTargetOrgUnitId\" : \"ou-lpzq-kmf17bec\",\n \"awsEnrollAccount\" : true,\n \"awsLambdaArn\" : \"arn:aws:lambda:us-east-1:123456789012:function:MyLambdaFunction\",\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRole\" : \"AwsSpecificRole\",\n \"policies\" : [ \"arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aws\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/23ffc575-4670-4379-879a-25effbea544b\"\n }\n }\n}"
},
"meshLandingZone-Post-gcp": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-gcp\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new gcp landing zone for testing\",\n \"displayName\" : \"New Landing Zone gcp\",\n \"platformRef\" : {\n \"uuid\" : \"8de142b8-8626-4eef-83a0-e99acf05fad2\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"gcpFolderId\" : \"12345\",\n \"gcpTemplateUrl\" : \"gs://my-bucket-name/folder/template\",\n \"gcpCloudFunctionUrl\" : \"https://us-central1-my-sample-project.cloudfunctions.net/helloWorld\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/owner\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\", \"roles/viewer\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-gcp\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/8de142b8-8626-4eef-83a0-e99acf05fad2\"\n }\n }\n}"
},
"meshLandingZone-Post-custom": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-custom\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new custom landing zone for testing\",\n \"displayName\" : \"New Landing Zone custom\",\n \"platformRef\" : {\n \"uuid\" : \"5c4082eb-84d2-48d5-9804-ba3f8e2fd563\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"custom\",\n \"custom\" : { }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-custom\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c4082eb-84d2-48d5-9804-ba3f8e2fd563\"\n }\n }\n}"
},
"meshLandingZone-Post-azurerg": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azurerg\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"A new azurerg landing zone for testing\",\n \"displayName\" : \"New Landing Zone azurerg\",\n \"platformRef\" : {\n \"uuid\" : \"e659bb60-3764-46b3-a4a2-5d82fcd1792d\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : false,\n \"automateDeletionReplication\" : false,\n \"infoLink\" : \"https://example.com/info\",\n \"platformProperties\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"azureRgLocation\" : \"eastus2\",\n \"azureRgRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"owner\",\n \"azureRoleDefinitionIds\" : [ \"fd876abe-603d-44d2-bf8a-067bbeacd485\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"reader\",\n \"azureRoleDefinitionIds\" : [ \"39a5f86f-a2d0-459d-b4eb-f536464933d0\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"user\",\n \"azureRoleDefinitionIds\" : [ \"492334bd-d0fd-4724-9270-e55495c2d88e\" ]\n } ],\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"78f9140e-1f7c-45a1-a633-3f1b92df362bn\"\n }\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azurerg\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/e659bb60-3764-46b3-a4a2-5d82fcd1792d\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshlocations": {
"get": {
"tags": [
"Locations"
],
"summary": "List locations",
"description": "List all meshLocations with optional pagination and filtering.\n\nLocations represent geographical or logical groupings of platform instances within meshStack.\nThey help organize cloud platforms by region, data center, or any other logical grouping.\n\nNo specific permission is required to read meshLocations \u2013 every API Key can list all available meshLocations.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLocation-List",
"parameters": [
{
"name": "displayName",
"in": "query",
"description": "Filter by exact display name (case-sensitive)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycleState",
"in": "query",
"description": "Filter by lifecycle state. Can be specified multiple times to filter for multiple states.\nValid values: ACTIVE, DELETED.\nDefault: ACTIVE (only active locations are returned if this parameter is omitted)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlocation.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshlocation.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLocation-List"
},
"examples": {
"meshLocation-List": {
"value": "{\n \"_embedded\" : {\n \"meshLocations\" : [ {\n \"kind\" : \"meshLocation\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"7db99cbb-6663-4ff8-b214-b405447a591c\",\n \"name\" : \"my-location\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"My Location\",\n \"description\" : \"My great location\"\n },\n \"status\" : {\n \"isPublic\" : true,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:25.860196334Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlocations/my-location\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlocations?displayName=My%20Location\"\n }\n },\n \"page\" : {\n \"size\" : 50,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Locations"
],
"summary": "Create location",
"description": "Create a new meshLocation. This endpoint requires save permissions for platforms (there is no dedicated permission for locations as platforms and locations are closely related).\n\nLocations represent geographical or logical groupings of platform instances and can be used\nto organize cloud platforms by region, data center, or any other logical grouping.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLocation-Post",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlocation.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlocation.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshlocation.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshlocations-1689823740"
},
"examples": {
"meshLocation-Post": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshLocation\",\n \"metadata\": {\n \"name\": \"new-location\",\n \"ownedByWorkspace\": \"platform-team\"\n },\n \"spec\": {\n \"displayName\": \"New Location\",\n \"description\": \"A new location created via API\"\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshlocation.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLocation-Post"
},
"examples": {
"meshLocation-Post": {
"value": "{\n \"kind\" : \"meshLocation\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"5895eb02-f5d3-4bf5-a746-2483af86c65c\",\n \"name\" : \"new-location\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"New Location\",\n \"description\" : \"A new location created via API\"\n },\n \"status\" : {\n \"isPublic\" : false,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:26.533775684Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlocations/new-location\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshpaymentmethods": {
"get": {
"tags": [
"Payment Methods"
],
"summary": "List payment methods",
"description": "List all meshPaymentMethods with pagination support. Deleted meshPaymentMethods are not included in the response.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPaymentMethodListV2",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for meshPaymentMethods that belong to the meshWorkspace with given identifier (optional). Note: the server will ignore this filter when the request principal does not have permission to read payment methods in any workspace.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPaymentMethodListV2"
},
"examples": {
"meshPaymentMethodListV2": {
"value": "{\n \"_embedded\" : {\n \"meshPaymentMethods\" : [ {\n \"kind\" : \"meshPaymentMethod\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-payment-method-1\",\n \"ownedByWorkspace\" : \"payment-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"Test Payment Method 1\",\n \"tags\" : { },\n \"amount\" : 1000\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment-method-1\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?paymentIdentifier=test-payment-method-1\"\n }\n }\n }, {\n \"kind\" : \"meshPaymentMethod\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-payment-method-2\",\n \"ownedByWorkspace\" : \"payment-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"Test Payment Method 2\",\n \"tags\" : { },\n \"amount\" : 1000\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment-method-2\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?paymentIdentifier=test-payment-method-2\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=payment-workspace&page=0&size=2&sort=id,asc\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=payment-workspace&page=0&size=2\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=payment-workspace&page=1&size=2&sort=id,asc\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=payment-workspace&page=1&size=2&sort=id,asc\"\n }\n },\n \"page\" : {\n \"size\" : 2,\n \"totalElements\" : 3,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Payment Methods"
],
"summary": "Create payment method",
"description": "Create a new meshPaymentMethod\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPaymentMethodV2Post",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshpaymentmethods1366945563"
},
"examples": {
"meshPaymentMethodV2Post": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPaymentMethod\",\n \"metadata\": {\n \"name\": \"new-payment-method\",\n \"ownedByWorkspace\": \"payment-workspace\"\n },\n \"spec\": {\n \"displayName\": \"New Payment Method\",\n \"amount\": 1000.00,\n \"expirationDate\": \"2025-12-31\",\n \"tags\": {}\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPaymentMethodV2Post"
},
"examples": {
"meshPaymentMethodV2Post": {
"value": "{\n \"kind\" : \"meshPaymentMethod\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"new-payment-method\",\n \"ownedByWorkspace\" : \"payment-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"New Payment Method\",\n \"tags\" : { },\n \"amount\" : 1000,\n \"expirationDate\" : \"2025-12-31\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/new-payment-method\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?paymentIdentifier=new-payment-method\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshplatforms": {
"get": {
"tags": [
"Platforms"
],
"summary": "List platforms",
"description": "List all meshPlatforms with pagination support. This example shows a paginated list response containing platforms of various types. Each platform in the list has the same structure as documented in the GET single platform response. Filter options use exact equals matching (not fuzzy search).\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatform-List-V",
"parameters": [
{
"name": "identifier",
"in": "query",
"description": "Filter by full platform identifier (provided in the metadata.name field, combination of platform identifier and location identifier, e.g., 'my-platform.location-1').",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "locationIdentifier",
"in": "query",
"description": "Filter by location identifier.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "ownedByWorkspace",
"in": "query",
"description": "Filter by workspace identifier that owns the platform.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "publicationState",
"in": "query",
"description": "Filter by publication state (e.g., UNPUBLISHED, PUBLISHED, REQUESTED, REJECTED).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "restriction",
"in": "query",
"description": "Filter by restriction type (e.g., PUBLIC, RESTRICTED, PRIVATE).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "displayName",
"in": "query",
"description": "Filter by platform display name.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "contributingWorkspace",
"in": "query",
"description": "Filter by workspace identifier(s) that contribute to the platform. Can be specified multiple times to search for platforms where ANY of the provided workspaces is a contributor (OR logic).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycleState",
"in": "query",
"description": "Filter by lifecycle state (ACTIVE, DEACTIVATED, MARKED_FOR_DELETION, DELETED). Can be specified multiple times to include multiple states (OR logic). When not specified, returns only ACTIVE and DEACTIVATED platforms (excludes deleted).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Page number for pagination (0-indexed).",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "Number of items per page.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatform.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshplatform.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-List-V2"
},
"examples": {
"meshPlatform-List-V2": {
"value": "{\n \"_embedded\" : {\n \"meshPlatforms\" : [ {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks-updated\",\n \"description\" : \"test-platform-aks-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:332e4dc99df352242856595f55f7dcbcd28b8181e4bf1826c66b6ecc5b8d0ffc\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:9ce9cafb613e39d35a53f58c7e360886a5bef899e6081d3113457b4fe39e3ed8\"\n }\n },\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"UserByMailLookupStrategy\",\n \"administrativeUnitId\" : \"3f52c8c1-9d4e-4c1a-b6df-1ea2f6b8f927\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:5b102d88fce1a04abe6ffa52afef8902654e8ec85ee594616cb416a4793f0178\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores Updated\",\n \"description\" : \"Maximum number of CPU cores (updated)\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 200,\n \"autoApprovalThreshold\" : 75\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory Updated\",\n \"description\" : \"Maximum memory allocation (updated)\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 1000,\n \"autoApprovalThreshold\" : 500\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws-updated\",\n \"description\" : \"test-platform-aws-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:451ba8e737d108df85efce60858480b605324f1d5ff0a01a155e04c65665ee94\"\n }\n }\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"accountNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : {\n \"hash\" : \"sha256:cc63c96418021bcaf7641c300b9f4d44c067197365f4b235e4ff8b463593a1d6\"\n },\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"ReaderRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n } ],\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n },\n \"metering\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:7436606196bf386c22e3ac2577fc9b60754138498315ab437d51d9ddc60cd769\"\n }\n }\n }\n },\n \"filter\" : \"NONE\",\n \"reservedInstanceFairChargeback\" : false,\n \"savingsPlanFairChargeback\" : false,\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure-updated\",\n \"description\" : \"test-platform-azure-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:1af7854464adfc1bd7eafcb4cc44ad02180c2ef89732169e205b058dd4ab4ee7\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:19da0f6b77d50986e79ad2a4dd0179444342d675ca6fd0cc534f92bde04829aa\"\n }\n }\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"updateSubscriptionName\" : true,\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n } ],\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n },\n \"metering\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:4eb3e9cb9c9cb3522684f049280c947e7213d4c22f9f16dc154bf134808216cf\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg-updated\",\n \"description\" : \"test-platform-azurerg-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:0d10d4d4f1e5fb821c76f7f64882742eb2207c9a44678b0178cb32fa2aabec50\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp-updated\",\n \"description\" : \"test-platform-gcp-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:ce4dde49bb254155882c920794a1e153cc1465b6eceb51562527957c09a23e15\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/owner\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/editor\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/viewer\"\n } ],\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n },\n \"metering\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:31bceadca7bfff0ba9437c135488ce43c6fc58224591515e741e802abd7bac81\"\n }\n },\n \"bigqueryTable\" : \"project.dataset.table\",\n \"bigqueryTableForCarbonFootprint\" : \"project.dataset.carbon_table\",\n \"carbonFootprintDataCollectionStartMonth\" : \"2023-01\",\n \"partitionTimeColumn\" : \"export_time\",\n \"additionalFilter\" : \"project.id != 'excluded-project'\",\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"kubernetes-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-kubernetes-updated\",\n \"description\" : \"test-platform-kubernetes-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:43f87c9214d556a6f5f8587ee90228046af51df331ef8e9642460d74c40c86f7\"\n }\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:89a31cddc33bd88ada13992c9cf746d5aa9024ce98aeae1427400bc0ac858595\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores Updated\",\n \"description\" : \"Maximum number of CPU cores (updated)\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 200,\n \"autoApprovalThreshold\" : 75\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory Updated\",\n \"description\" : \"Maximum memory allocation (updated)\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 1000,\n \"autoApprovalThreshold\" : 500\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"openshift-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-openshift-updated\",\n \"description\" : \"test-platform-openshift-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:24675154c601e2b99c1296ae0d0aa36eec61045947574f3c4e61ca5e5c874235\"\n }\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"openshiftRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"admin\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"edit\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"view\"\n } ],\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:97869850209bdd7ebd63e1727465c680ba90a62fb8f3f3acf20d609b3d8e6400\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores Updated\",\n \"description\" : \"Maximum number of CPU cores (updated)\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 200,\n \"autoApprovalThreshold\" : 75\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory Updated\",\n \"description\" : \"Maximum memory allocation (updated)\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 1000,\n \"autoApprovalThreshold\" : 500\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"custom-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-custom-updated\",\n \"description\" : \"test-platform-custom-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"custom\",\n \"custom\" : {\n \"platformTypeRef\" : {\n \"name\" : \"my-custom-platform-type\",\n \"kind\" : \"meshPlatformType\"\n },\n \"metering\" : {\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms?page=0&size=20&ownedByWorkspace=test-workspace\"\n }\n },\n \"page\" : {\n \"size\" : 20,\n \"totalElements\" : 8,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshplatform.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-List-V1"
},
"examples": {
"meshPlatform-List-V1": {
"value": "{\n \"_embedded\" : {\n \"meshPlatforms\" : [ {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"os\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"20724f73-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-central\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"OpenStack Ocata\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"https://os.dev.eu-de-central.msh.host:5000/v3\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/20724f73-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"cf\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"20725036-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-central\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"Cloud Foundry\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"https://api.cf.msh.host\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/20725036-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"cf\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"207250a3-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-netde\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"Cloud Foundry\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"http://example.com\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"DELETED\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/207250a3-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"sr\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"207250f4-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-central\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"Marketplace\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"/marketplaces/1/api\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/207250f4-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"sr\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"2072521e-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-netde\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"Marketplace\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"/marketplaces/2/api\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/2072521e-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"ospike\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"20725276-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-central\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"OpenStack Pike\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"http://185.80.184.185:5000/v3\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/20725276-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aws\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"207252c2-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"aws-meshstack-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"AWS\",\n \"description\" : \"Amazon Web Services (AWS) is a subsidiary of Amazon.com that provides on-demand cloud computing platforms to individuals, companies and governments, on a paid subscription basis. The technology allows subscribers to have at their disposal a virtual cluster of computers, available all the time, through the Internet.\",\n \"endpoint\" : \"https://aws.amazon.com\",\n \"documentationUrl\" : \"https://aws.amazon.com/\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/207252c2-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"okd\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"20725309-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-central\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"OpenShift\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"https://okd.dev.eu-de-central.msh.host:8443/\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"DELETED\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/20725309-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"k8s\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"2072534f-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-central\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"Kubernetes\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"https://k8s.dev.eu-de-central.msh.host:6443\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/2072534f-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"sr\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"20725398-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"global\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"Marketplace\",\n \"endpoint\" : \"/marketplaces/3/api\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/20725398-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azure\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"207253df-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"meshcloud-azure-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"Azure\",\n \"description\" : \"Azure is the Public Cloud Service provided by Microsoft.\",\n \"endpoint\" : \"https://azure.microsoft.com\",\n \"documentationUrl\" : \"https://azure.microsoft.com\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/207253df-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"sr\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"20725428-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"marketplace-demo-customer\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"RESTRICTED\",\n \"restrictedToWorkspaces\" : [ \"demo-customer\" ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"Marketplace\",\n \"endpoint\" : \"/marketplaces/4/api\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/20725428-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"gcp\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"20725471-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"gcp-meshstack-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"GCP\",\n \"description\" : \"GCP is the Public Cloud Service provided by Google.\",\n \"endpoint\" : \"https://cloud.google.com\",\n \"documentationUrl\" : \"https://cloud.google.com\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/20725471-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"okd-on-gcp\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"207254b9-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"openshift\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"OpenShift on GCP\",\n \"description\" : \"OpenShift is a family of containerization software developed by Red Hat. Its flagship product is the OpenShift Container Platform\u2014an on-premises platform as a service built around Docker containers orchestrated and managed by Kubernetes on a foundation of Red Hat Enterprise Linux.\",\n \"endpoint\" : \"https://console-openshift-console.apps.dev.okd.msh.host/\",\n \"documentationUrl\" : \"https://www.openshift.com/\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/207254b9-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"openstack\",\n \"ownedByWorkspace\" : \"tmp-migration-partner\",\n \"uuid\" : \"21e42fd3-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"eu-de-central\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PUBLIC\",\n \"restrictedToWorkspaces\" : [ ],\n \"marketplaceStatus\" : \"PUBLISHED\"\n },\n \"displayName\" : \"openstack\",\n \"description\" : \"The latest and greatest cloud platforms provided by your favourite SRE team. Will rock your socks off.\",\n \"endpoint\" : \"https://openstack.kolla.msh.host:5000/v3\",\n \"documentationUrl\" : \"https://www.meshcloud.io\",\n \"config\" : {\n \"type\" : \"unsupported\"\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"marketPlace\" : {\n \"status\" : \"PUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/21e42fd3-5f55-11f1-b5b7-ea2e59a79531\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/tmp-migration-partner\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks-updated\",\n \"description\" : \"test-platform-aks-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : \"mesh/hidden-secret\",\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"administrativeUnitId\" : \"12345678-1234-1234-1234-123456789012\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws-updated\",\n \"description\" : \"test-platform-aws-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"serviceUserConfig\" : {\n \"accessKey\" : \"*****\",\n \"secretKey\" : \"mesh/hidden-secret\"\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : \"mesh/hidden-secret\",\n \"roleMappings\" : {\n \"admin\" : {\n \"awsRoleName\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n },\n \"member\" : {\n \"awsRoleName\" : \"MemberRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n }\n },\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure-updated\",\n \"description\" : \"test-platform-azure-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\"\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"roleMappings\" : {\n \"admin\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n },\n \"member\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n },\n \"reader\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n },\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg-updated\",\n \"description\" : \"test-platform-azurerg-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n }, {\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp-updated\",\n \"description\" : \"test-platform-gcp-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccountConfig\" : {\n \"serviceAccountCredentialsConfig\" : {\n \"serviceAccountCredentialsB64\" : \"mesh/hidden-secret\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"roleMappings\" : {\n \"admin\" : \"roles/owner\",\n \"member\" : \"roles/editor\",\n \"reader\" : \"roles/viewer\"\n },\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms?ownedByWorkspace=test-workspace&page=0&size=20&sort=id,asc\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms?page=0&size=20&ownedByWorkspace=test-workspace\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms?ownedByWorkspace=test-workspace&page=1&size=20&sort=id,asc\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms?ownedByWorkspace=test-workspace&page=1&size=20&sort=id,asc\"\n }\n },\n \"page\" : {\n \"size\" : 20,\n \"totalElements\" : 22,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Platforms"
],
"summary": "Create platform",
"description": "Create a new platform including its full configuration. The examples show all available configuration options for a given platform type.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatform-Post-V",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatform.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatform.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshplatform.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshplatforms-1654402271"
},
"examples": {
"meshPlatform-Post-V1-aks": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"aks-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aks\",\n \"description\": \"test-platform-aks\",\n \"endpoint\": \"\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : \"*****\",\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\",\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"administrativeUnitId\" : \"12345678-1234-1234-1234-123456789012\"\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V1-aws": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"aws-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aws\",\n \"description\": \"test-platform-aws\",\n \"endpoint\": \"\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"serviceUserConfig\" : {\n \"accessKey\" : \"*****\",\n \"secretKey\" : \"*****\"\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : \"sso-access-token-value\",\n \"roleMappings\" : {\n \"admin\" : {\n \"awsRoleName\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n },\n \"member\" : {\n \"awsRoleName\" : \"MemberRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n }\n },\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V1-gcp": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"gcp-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-gcp\",\n \"description\": \"test-platform-gcp\",\n \"endpoint\": \"\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccountConfig\" : {\n \"serviceAccountCredentialsConfig\" : {\n \"serviceAccountCredentialsB64\" : \"*****\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"roleMappings\" : {\n \"admin\" : \"roles/owner\",\n \"member\" : \"roles/editor\",\n \"reader\" : \"roles/viewer\"\n },\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V1-openshift": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"openshift-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-openshift\",\n \"description\": \"test-platform-openshift\",\n \"endpoint\": \"\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"*****\"\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"roleMappings\" : {\n \"admin\" : \"admin\",\n \"member\" : \"edit\",\n \"reader\" : \"view\"\n },\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V1-kubernetes": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"kubernetes-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-kubernetes\",\n \"description\": \"test-platform-kubernetes\",\n \"endpoint\": \"\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"*****\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V1-azurerg": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"azurerg-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azurerg\",\n \"description\": \"test-platform-azurerg\",\n \"endpoint\": \"\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V1-azure": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"azure-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azure\",\n \"description\": \"test-platform-azure\",\n \"endpoint\": \"\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\"\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"roleMappings\" : {\n \"admin\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n },\n \"member\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n },\n \"reader\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n },\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n }\n }\n}\n }\n }"
}
}
},
"application/vnd.meshcloud.api.meshplatform.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshplatforms-86531993"
},
"examples": {
"meshPlatform-Post-V2-aks": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"aks-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aks\",\n \"description\": \"test-platform-aks\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [{\n \"quotaKey\": \"cpu\",\n \"label\": \"CPU Cores\",\n \"description\": \"Maximum number of CPU cores\",\n \"unit\": \"cores\",\n \"minValue\": 1,\n \"maxValue\": 100,\n \"autoApprovalThreshold\": 50\n},\n{\n \"quotaKey\": \"memory\",\n \"label\": \"Memory\",\n \"description\": \"Maximum memory allocation\",\n \"unit\": \"GB\",\n \"minValue\": 1,\n \"maxValue\": 500,\n \"autoApprovalThreshold\": 250\n}],\n \"config\": {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"UserByMailLookupStrategy\",\n \"administrativeUnitId\" : \"3f52c8c1-9d4e-4c1a-b6df-1ea2f6b8f927\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V2-azure": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"azure-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azure\",\n \"description\": \"test-platform-azure\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n }\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"updateSubscriptionName\" : true,\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n } ],\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n },\n \"metering\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V2-custom": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"custom-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-custom\",\n \"description\": \"test-platform-custom\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"custom\",\n \"custom\" : {\n \"platformTypeRef\" : {\n \"name\" : \"my-custom-platform-type\",\n \"kind\" : \"meshPlatformType\"\n },\n \"metering\" : {\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V2-gcp": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"gcp-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-gcp\",\n \"description\": \"test-platform-gcp\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/owner\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/editor\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/viewer\"\n } ],\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n },\n \"metering\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"bigqueryTable\" : \"project.dataset.table\",\n \"bigqueryTableForCarbonFootprint\" : \"project.dataset.carbon_table\",\n \"carbonFootprintDataCollectionStartMonth\" : \"2023-01\",\n \"partitionTimeColumn\" : \"export_time\",\n \"additionalFilter\" : \"project.id != 'excluded-project'\",\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V2-kubernetes": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"kubernetes-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-kubernetes\",\n \"description\": \"test-platform-kubernetes\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [{\n \"quotaKey\": \"cpu\",\n \"label\": \"CPU Cores\",\n \"description\": \"Maximum number of CPU cores\",\n \"unit\": \"cores\",\n \"minValue\": 1,\n \"maxValue\": 100,\n \"autoApprovalThreshold\": 50\n},\n{\n \"quotaKey\": \"memory\",\n \"label\": \"Memory\",\n \"description\": \"Maximum memory allocation\",\n \"unit\": \"GB\",\n \"minValue\": 1,\n \"maxValue\": 500,\n \"autoApprovalThreshold\": 250\n}],\n \"config\": {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V2-aws": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"aws-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aws\",\n \"description\": \"test-platform-aws\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"plaintext\" : \"sample-secret\"\n }\n }\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"accountNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : {\n \"plaintext\" : \"sso-access-token-value\"\n },\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"ReaderRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n } ],\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n },\n \"metering\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"plaintext\" : \"sample-secret\"\n }\n }\n }\n },\n \"filter\" : \"NONE\",\n \"reservedInstanceFairChargeback\" : false,\n \"savingsPlanFairChargeback\" : false,\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V2-azurerg": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"azurerg-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azurerg\",\n \"description\": \"test-platform-azurerg\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n}\n }\n }"
},
"meshPlatform-Post-V2-openshift": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"name\": \"openshift-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-openshift\",\n \"description\": \"test-platform-openshift\",\n \"endpoint\": \"https://example.com\",\n \"supportUrl\": \"\",\n \"documentationUrl\": \"\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [{\n \"quotaKey\": \"cpu\",\n \"label\": \"CPU Cores\",\n \"description\": \"Maximum number of CPU cores\",\n \"unit\": \"cores\",\n \"minValue\": 1,\n \"maxValue\": 100,\n \"autoApprovalThreshold\": 50\n},\n{\n \"quotaKey\": \"memory\",\n \"label\": \"Memory\",\n \"description\": \"Maximum memory allocation\",\n \"unit\": \"GB\",\n \"minValue\": 1,\n \"maxValue\": 500,\n \"autoApprovalThreshold\": 250\n}],\n \"config\": {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"openshiftRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"admin\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"edit\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"view\"\n } ],\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshplatform.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-Post-V1-aks"
},
"examples": {
"meshPlatform-Post-V1-aks": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks\",\n \"description\" : \"test-platform-aks\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : \"mesh/hidden-secret\",\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"administrativeUnitId\" : \"12345678-1234-1234-1234-123456789012\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V1-aws": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws\",\n \"description\" : \"test-platform-aws\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"serviceUserConfig\" : {\n \"accessKey\" : \"*****\",\n \"secretKey\" : \"mesh/hidden-secret\"\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : \"mesh/hidden-secret\",\n \"roleMappings\" : {\n \"admin\" : {\n \"awsRoleName\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n },\n \"member\" : {\n \"awsRoleName\" : \"MemberRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n }\n },\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V1-gcp": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp\",\n \"description\" : \"test-platform-gcp\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccountConfig\" : {\n \"serviceAccountCredentialsConfig\" : {\n \"serviceAccountCredentialsB64\" : \"mesh/hidden-secret\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"roleMappings\" : {\n \"admin\" : \"roles/owner\",\n \"member\" : \"roles/editor\",\n \"reader\" : \"roles/viewer\"\n },\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V1-openshift": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"openshift-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"1a7ee47e-1f55-4e31-b83f-9f17ca347b89\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-openshift\",\n \"description\" : \"test-platform-openshift\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"mesh/hidden-secret\"\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"roleMappings\" : {\n \"admin\" : \"admin\",\n \"member\" : \"edit\",\n \"reader\" : \"view\"\n },\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/1a7ee47e-1f55-4e31-b83f-9f17ca347b89\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V1-kubernetes": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"kubernetes-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"64b5a735-1dc3-4208-a0c6-e16d9d5949d4\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-kubernetes\",\n \"description\" : \"test-platform-kubernetes\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"mesh/hidden-secret\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/64b5a735-1dc3-4208-a0c6-e16d9d5949d4\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V1-azurerg": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg\",\n \"description\" : \"test-platform-azurerg\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V1-azure": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure\",\n \"description\" : \"test-platform-azure\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\"\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"roleMappings\" : {\n \"admin\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n },\n \"member\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n },\n \"reader\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n },\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshplatform.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-Post-V2-aks"
},
"examples": {
"meshPlatform-Post-V2-aks": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks\",\n \"description\" : \"test-platform-aks\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:7a676636f3f7fed0195abbfbd313cf8f5fdf8f268731a7d7bafae2bc709e1c2d\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:02f84a1c8ca6a25f44f5a39a213a82d6a4beec551386d1ff2c7f4e4175015af9\"\n }\n },\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"UserByMailLookupStrategy\",\n \"administrativeUnitId\" : \"3f52c8c1-9d4e-4c1a-b6df-1ea2f6b8f927\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:e366a9440c504f6b9fd88da6c57efb585023e05037d62fd36b7b6d9868f45f93\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores\",\n \"description\" : \"Maximum number of CPU cores\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 100,\n \"autoApprovalThreshold\" : 50\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory\",\n \"description\" : \"Maximum memory allocation\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 500,\n \"autoApprovalThreshold\" : 250\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V2-azure": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure\",\n \"description\" : \"test-platform-azure\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:cd88221a6c67fa850d9b99a3f3b1247d062875e0d99ab544d33b423697037dec\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:1dc8fea647050c0c27e6fad964b3c19a066fec44e49c9f5469c06370fc50280c\"\n }\n }\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"updateSubscriptionName\" : true,\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n } ],\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n },\n \"metering\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:aa18ffce72924b4f1fa98b48d486e05c70361e52a96e1a4033415898e9439464\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V2-custom": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"custom-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-custom\",\n \"description\" : \"test-platform-custom\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"custom\",\n \"custom\" : {\n \"platformTypeRef\" : {\n \"name\" : \"my-custom-platform-type\",\n \"kind\" : \"meshPlatformType\"\n },\n \"metering\" : {\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V2-gcp": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp\",\n \"description\" : \"test-platform-gcp\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:f3b44d3b9aa82c3da062065f546d7032a89237f34920330583fdae9d2f19454b\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/owner\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/editor\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/viewer\"\n } ],\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n },\n \"metering\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:fd4b628af60145189a5c9aab20da50f6eb57fd66dc8d16e5b9f09b7d0c8925c6\"\n }\n },\n \"bigqueryTable\" : \"project.dataset.table\",\n \"bigqueryTableForCarbonFootprint\" : \"project.dataset.carbon_table\",\n \"carbonFootprintDataCollectionStartMonth\" : \"2023-01\",\n \"partitionTimeColumn\" : \"export_time\",\n \"additionalFilter\" : \"project.id != 'excluded-project'\",\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V2-kubernetes": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"kubernetes-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-kubernetes\",\n \"description\" : \"test-platform-kubernetes\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:e430b770c608e9af8bf43394a0d166787aa3151d032fa5d4ccbdfcba716ab196\"\n }\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:5bcd36368452a3c7ef77443dc1fa4840adb032d1c963b94548c89b87fb3860b3\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores\",\n \"description\" : \"Maximum number of CPU cores\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 100,\n \"autoApprovalThreshold\" : 50\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory\",\n \"description\" : \"Maximum memory allocation\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 500,\n \"autoApprovalThreshold\" : 250\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V2-aws": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws\",\n \"description\" : \"test-platform-aws\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:59e61bb8773997c254d39d9842a51fa4314ad234ee30ad713ee7d1e917ca3d1f\"\n }\n }\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"accountNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : {\n \"hash\" : \"sha256:7ba7480d65686e536362a02dd0be0cb7840f04728d2660e68f5ef3124be4003a\"\n },\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"ReaderRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n } ],\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n },\n \"metering\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:a8a2a7399fb7de1e903a180ce476bc40244429a2d1d7f3c3d51b178ab0ca3694\"\n }\n }\n }\n },\n \"filter\" : \"NONE\",\n \"reservedInstanceFairChargeback\" : false,\n \"savingsPlanFairChargeback\" : false,\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V2-azurerg": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg\",\n \"description\" : \"test-platform-azurerg\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:b6ec4478ddfdffe8426c8b378993c749576a4b3ec0148ac7c3a1eeb448380173\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Post-V2-openshift": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"openshift-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-openshift\",\n \"description\" : \"test-platform-openshift\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:8eaed76413d1be1cd5327caf27eb0b0d71317d8fe5e59d18d51bad5e1b8ef2f0\"\n }\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"openshiftRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"admin\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"edit\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"view\"\n } ],\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:6b5de27e6f7878b190e27ddf534a9a9d197cc8e86a40a0eaf4f70b1057e91ac2\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores\",\n \"description\" : \"Maximum number of CPU cores\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 100,\n \"autoApprovalThreshold\" : 50\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory\",\n \"description\" : \"Maximum memory allocation\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 500,\n \"autoApprovalThreshold\" : 250\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshplatformtypes": {
"get": {
"tags": [
"Platform Types"
],
"summary": "List platform types",
"description": "List all meshPlatformTypes with optional pagination and filtering.\n\nPlatform types define the available cloud platform technologies that can be used within meshStack.\nThis includes both built-in platform types (AWS, Azure, GCP, etc.) and custom platform types.\n\nYou can optionally filter the results by category and/or lifecycle status.\nFor example, use `category=CUSTOM` to retrieve only custom platform types,\nor `lifecycleState=ACTIVE` to retrieve only active platform types.\nBoth filters can be combined to further refine the results.\n\nNo specific permission is required to read meshPlatformTypes \u2013 every API Key can list all available meshPlatformTypes.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatformTypeListV1",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "category",
"in": "query",
"description": "Optional filter by platform category. Only platform types matching the specified category will be returned. Possible values: OPENSTACK, CLOUDFOUNDRY, SERVICEREGISTRY, AWS, OPENSHIFT, KUBERNETES, AZURE, GCP, AZURE_KUBERNETES_SERVICE, AZURE_RESOURCE_GROUP, CUSTOM, GITHUB.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lifecycleState",
"in": "query",
"description": "Optional filter by lifecycle state. Only platform types matching the specified lifecycle state will be returned. Possible values: ACTIVE, DEACTIVATED.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatformtype.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshplatformtype.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatformTypeListV1"
},
"examples": {
"meshPlatformTypeListV1": {
"value": "{\n \"_embedded\" : {\n \"meshPlatformTypes\" : [ {\n \"kind\" : \"meshPlatformType\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"271b7548-5f55-11f1-b5b7-ea2e59a79531\",\n \"name\" : \"STACKIT\",\n \"ownedByWorkspace\" : \"demo-partner\"\n },\n \"spec\" : {\n \"displayName\" : \"STACKIT\",\n \"category\" : \"CUSTOM\",\n \"defaultEndpoint\" : \"https://portal.stackit.cloud\",\n \"icon\" : \"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMCIgaGVpZ2h0PSIzMCIgdmlld0JveD0iMCAwIDMwIDIyIiBmaWxsPSIjMDA0ZTVhIj4KICA8cGF0aCBkPSJNNy42NzM4MSAwTDQuOTk2ODMgMTIuNTQ0NkgxMS42ODk0TDEzLjEyOTggNS43OTYxN0gyOC42MzM2TDI5Ljg3MDIgMEg3LjY3MzgxWiIgLz4KICA8cGF0aCBkPSJNMTguMjQwNSA5LjQxNjk5TDE2Ljc5MTkgMTYuMjA0M0gxLjIzNjIzTDAgMjIuMDAwNEgyMi4yNDc2TDI0LjkzMzEgOS40MTY5OUgxOC4yNDA1WiIgLz4KPC9zdmc+\"\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:04:35.816426Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatformtypes/STACKIT\"\n }\n }\n }, {\n \"kind\" : \"meshPlatformType\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"5503a2ca-85a4-4aa5-82a3-08f491db5785\",\n \"name\" : \"my-platform-type\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"My Platform Type\",\n \"category\" : \"CUSTOM\",\n \"defaultEndpoint\" : \"https://custom.example.com\",\n \"icon\" : \"data:image/png;base64,iVBORw0KGgo...\"\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:39.026304500Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatformtypes/my-platform-type\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatformtypes?category=CUSTOM&page=0&size=10\"\n }\n },\n \"page\" : {\n \"size\" : 10,\n \"totalElements\" : 2,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Platform Types"
],
"summary": "Create platform type",
"description": "Create a new custom meshPlatformType. This endpoint requires the permission to save platforms.\n\nCustom platform types allow you to define new cloud platform technologies beyond the built-in types.\nThis enables integration with proprietary or emerging cloud platforms.\n\nNote: Only custom platform types can be created via the API. Built-in platform types (AWS, Azure, GCP, etc.)\nare pre-configured in meshStack.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatformTypeV1Post",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatformtype.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatformtype.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshplatformtype.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshplatformtypes382571989"
},
"examples": {
"meshPlatformTypeV1Post": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatformType\",\n \"metadata\": {\n \"name\": \"my-new-platform\",\n \"ownedByWorkspace\": \"platform-team\"\n },\n \"spec\": {\n \"displayName\": \"My New Platform\",\n \"category\": \"CUSTOM\",\n \"defaultEndpoint\": \"https://platform.example.com\",\n \"icon\": \"data:image/png;base64,iVBORw0KGgo...\"\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshplatformtype.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatformTypeV1Post"
},
"examples": {
"meshPlatformTypeV1Post": {
"value": "{\n \"kind\" : \"meshPlatformType\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"1714bd8e-a78e-4713-b21d-1b99ef87f6ef\",\n \"name\" : \"my-new-platform\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"My New Platform\",\n \"category\" : \"CUSTOM\",\n \"defaultEndpoint\" : \"https://platform.example.com\",\n \"icon\" : \"data:image/png;base64,iVBORw0KGgo...\"\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:39.686160401Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatformtypes/my-new-platform\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojectroles": {
"get": {
"tags": [
"Project Role Definitions"
],
"summary": "List project roles",
"description": "List all meshProjectRoles with optional filtering and pagination.\n\nNo specific permission is required to read meshProjectRoles \u2013 every API Key can list all available meshProjectRoles.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectRoleListV1",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectrole.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshprojectrole.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectRoleListV1"
},
"examples": {
"meshProjectRoleListV1": {
"value": "{\n \"_embedded\" : {\n \"meshProjectRoles\" : [ {\n \"kind\" : \"meshProjectRole\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"project-admin\",\n \"tags\" : {\n \"priority\" : [ \"high\" ],\n \"access\" : [ \"admin\" ]\n }\n },\n \"spec\" : {\n \"name\" : \"Project Administrator\",\n \"description\" : \"Full administrative access to projects\",\n \"rank\" : 100\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles/project-admin\"\n }\n }\n }, {\n \"kind\" : \"meshProjectRole\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"project-member\",\n \"tags\" : {\n \"priority\" : [ \"standard\" ],\n \"access\" : [ \"member\" ]\n }\n },\n \"spec\" : {\n \"name\" : \"Project Member\",\n \"description\" : \"Standard user access to projects\",\n \"rank\" : 50\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles/project-member\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles?page=0&size=2\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles?page=0&size=2\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles?page=1&size=2\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles?page=2&size=2\"\n }\n },\n \"page\" : {\n \"size\" : 2,\n \"totalElements\" : 5,\n \"totalPages\" : 3,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Project Role Definitions"
],
"summary": "Create project role",
"description": "Create a new meshProjectRole with specified permissions and rank.\nProject roles define the level of access and permissions that users have within projects.\nThey are used to control what actions users can perform on project resources and configurations.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectRoleV1Post",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectrole.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectrole.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshprojectrole.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectroles486549215"
},
"examples": {
"meshProjectRoleV1Post": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshProjectRole\",\n \"metadata\": {\n \"name\": \"project-viewer\",\n \"tags\": {\n \"priority\": [\"low\"],\n \"access\": [\"user\"]\n }\n },\n \"spec\": {\n \"name\": \"Project Viewer\",\n \"description\": \"Read-only access to project resources\",\n \"rank\": 10\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshprojectrole.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectRoleV1Post"
},
"examples": {
"meshProjectRoleV1Post": {
"value": "{\n \"kind\" : \"meshProjectRole\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"project-viewer\",\n \"tags\" : {\n \"priority\" : [ \"low\" ],\n \"access\" : [ \"user\" ]\n }\n },\n \"spec\" : {\n \"name\" : \"Project Viewer\",\n \"description\" : \"Read-only access to project resources\",\n \"rank\" : 10\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles/project-viewer\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojects": {
"get": {
"tags": [
"Projects"
],
"summary": "List projects",
"description": "List all meshProjects with filtering and pagination support\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectListV2",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for meshProjects that belong to the meshWorkspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "paymentIdentifier",
"in": "query",
"description": "Filter for meshProjects that have the meshPaymentMethod with given identifier assigned. Substitute Payment Methods on meshProjects are not considered! Use an empty or blank value to filter for meshProjects without an assigned meshPaymentMethod. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "Filter for meshProjects with a certain deletion state. Possible values are: +\n[ACTIVE] (default option) All meshProjects that are not deleted or submitted for deletion, +\n[PENDING_DELETION] meshProjects which are in a state of deletion. It means the system is waiting for all tenants to be successfully deleted after all tenants are gone the project itself is deleted, +\n[DELETED] meshProjects which are fully deleted now, keep in mind that the identifier is changed (a timestamp is appended) after deletion so you might not use this as an identifying property. +\nYou can search for different states at once when you separate them via a comma. This parameter is only usable from meshProject media type version 2 or higher.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshproject.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshproject.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectListV2"
},
"examples": {
"meshProjectListV2": {
"value": "{\n \"_embedded\" : {\n \"meshProjects\" : [ {\n \"kind\" : \"meshProject\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-project-1\",\n \"ownedByWorkspace\" : \"4kkx3mpdsv1\",\n \"createdOn\" : \"2024-01-01T00:00:00Z\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated Test Project 1\",\n \"tags\" : {\n \"environment\" : [ \"production\" ],\n \"costCenter\" : [ \"4058\" ]\n },\n \"paymentMethodIdentifier\" : \"test-payment\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects/4kkx3mpdsv1.test-project-1\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"activePaymentMethod\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment\"\n },\n \"meshprojectuserbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"meshprojectgroupbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=4kkx3mpdsv1&paymentIdentifier=test-payment&state=ACTIVE&page=0&size=1&sort=id,asc\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=4kkx3mpdsv1&paymentIdentifier=test-payment&state=ACTIVE&page=0&size=1\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=4kkx3mpdsv1&paymentIdentifier=test-payment&state=ACTIVE&page=1&size=1&sort=id,asc\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=4kkx3mpdsv1&paymentIdentifier=test-payment&state=ACTIVE&page=1&size=1&sort=id,asc\"\n }\n },\n \"page\" : {\n \"size\" : 1,\n \"totalElements\" : 2,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Projects"
],
"summary": "Create a project",
"description": "Create a new meshProject\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectPost",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshproject.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshproject.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshproject.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojects-600031310"
},
"examples": {
"meshProjectPost": {
"value": "{\n \"apiVersion\" : \"v2\",\n \"kind\": \"meshProject\",\n \"spec\" : {\n \"displayName\" : \"Test Project 3\",\n \"tags\" : { },\n \"paymentMethodIdentifier\" : \"test-payment\"\n },\n \"metadata\" : {\n \"name\" : \"test-project-3\",\n \"ownedByWorkspace\" : \"4kkx3mpdsv1\"\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshproject.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectPost"
},
"examples": {
"meshProjectPost": {
"value": "{\n \"kind\" : \"meshProject\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-project-3\",\n \"ownedByWorkspace\" : \"4kkx3mpdsv1\",\n \"createdOn\" : \"2026-06-03T14:05:42.409808159Z\"\n },\n \"spec\" : {\n \"displayName\" : \"Test Project 3\",\n \"tags\" : { },\n \"paymentMethodIdentifier\" : \"test-payment\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects/4kkx3mpdsv1.test-project-3\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-3\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-3\"\n },\n \"activePaymentMethod\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment\"\n },\n \"meshprojectuserbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-3\"\n },\n \"meshprojectgroupbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-3\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshserviceinstances": {
"get": {
"tags": [
"Service Instances"
],
"summary": "List service instances",
"description": "List all meshServiceInstances with optional filtering and pagination support\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshServiceInstanceListV2",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for meshServiceInstances that are part of the meshWorkspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "projectIdentifier",
"in": "query",
"description": "Requires workspaceIdentifier. Filter for meshServiceInstances that are part of the meshProject of a certain workspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "marketplaceIdentifier",
"in": "query",
"description": "Filter for meshServiceInstances that are part of a marketplace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "serviceIdentifier",
"in": "query",
"description": "Filter for meshServiceInstances with given service identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "planIdentifier",
"in": "query",
"description": "Requires serviceIdentifier. Filter for meshServiceInstances with a given service plan identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "serviceBrokerIdentifier",
"in": "query",
"description": "Filter for meshServiceInstances managed by the service broker with the given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshServiceInstanceListV2"
},
"examples": {
"meshServiceInstanceListV2": {
"value": "{\n \"_embedded\" : {\n \"meshServiceInstances\" : [ {\n \"kind\" : \"meshServiceInstance\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"ownedByProject\" : \"4kkx3mtdg11\",\n \"ownedByWorkspace\" : \"my-mobile-app-team\",\n \"marketplaceIdentifier\" : \"4kkx3mtdg1\",\n \"instanceId\" : \"4kkx3mtdg9\"\n },\n \"spec\" : {\n \"displayName\" : \"4kkx3mtdg12\",\n \"serviceId\" : \"4kkx3mtdg5\",\n \"planId\" : \"4kkx3mtdg7\",\n \"serviceBrokerIdentifier\" : \"4kkx3mtdg3\",\n \"parameters\" : {\n \"parameter1\" : \"value1\",\n \"parameter2\" : 2,\n \"parameter3\" : true\n },\n \"creator\" : \"Unknown\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances/4kkx3mtdg9\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances?workspaceIdentifier=my-mobile-app-team&page=0&size=1\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances?workspaceIdentifier=my-mobile-app-team&page=0&size=1\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances?workspaceIdentifier=my-mobile-app-team&page=1&size=1\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances?workspaceIdentifier=my-mobile-app-team&page=1&size=1\"\n }\n },\n \"page\" : {\n \"size\" : 1,\n \"totalElements\" : 2,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Service Instances"
],
"summary": "Create a service instance",
"description": "Create a Service Instance\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshServiceInstancePost",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshserviceinstances406726350"
},
"examples": {
"meshServiceInstancePost": {
"value": "{\n \"apiVersion\" : \"v2\",\n \"kind\" : \"meshServiceInstance\",\n \"metadata\" : {\n \"ownedByProject\" : \"production\",\n \"ownedByWorkspace\" : \"my-mobile-app-team\",\n \"marketplaceIdentifier\" : \"eu-west-1\",\n \"instanceId\" : \"serviceInstanceId\"\n },\n \"spec\" : {\n \"displayName\" : \"New SI\",\n \"serviceId\" : \"4kkx3mtdg20\",\n \"planId\" : \"4kkx3mtdg22\",\n \"parameters\" : {\n \"key1\" : \"value1\",\n \"key2\" : \"value2\"\n },\n \"creator\" : \"alice@example.com\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshServiceInstancePost"
},
"examples": {
"meshServiceInstancePost": {
"value": "{\n \"kind\" : \"meshServiceInstance\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"ownedByProject\" : \"production\",\n \"ownedByWorkspace\" : \"my-mobile-app-team\",\n \"marketplaceIdentifier\" : \"eu-west-1\",\n \"instanceId\" : \"serviceInstanceId\"\n },\n \"spec\" : {\n \"displayName\" : \"New SI\",\n \"serviceId\" : \"4kkx3mtdg20\",\n \"planId\" : \"4kkx3mtdg22\",\n \"serviceBrokerIdentifier\" : \"4kkx3mtdg18\",\n \"parameters\" : {\n \"key1\" : \"value1\",\n \"key2\" : \"value2\"\n },\n \"creator\" : \"Unknown\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances/serviceInstanceId\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshtagdefinitions": {
"get": {
"tags": [
"Tag Definitions"
],
"summary": "List tag definitions",
"description": "List all meshTagDefinitions with pagination support.\n\nA meshTagDefinition defines additional metadata (tags) attached to all meshObjects of a specific kind.\nThe meshTagDefinition describes a schema for this metadata.\n\n**Note**: Reading meshTagDefinitions does not require any special permissions. All API Keys and API\nUsers set up via meshPanel have read access to meshTagDefinitions by default.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTagDefinitionList",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTagDefinitionList"
},
"examples": {
"meshTagDefinitionList": {
"value": "{\n \"_embedded\" : {\n \"meshTagDefinitions\" : [ {\n \"kind\" : \"meshTagDefinition\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"meshWorkspace.costCenter\"\n },\n \"spec\" : {\n \"targetKind\" : \"meshWorkspace\",\n \"key\" : \"costCenter\",\n \"valueType\" : {\n \"string\" : {\n \"defaultValue\" : \"1001\",\n \"validationRegex\" : \"^\\\\d{4}$\"\n }\n },\n \"description\" : \"Must be exactly 4 digits.\",\n \"displayName\" : \"Cost Center\",\n \"sortOrder\" : 9999,\n \"mandatory\" : true,\n \"immutable\" : false,\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions/meshWorkspace.costCenter\"\n }\n }\n }, {\n \"kind\" : \"meshTagDefinition\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"meshWorkspace.workspaceOwner\"\n },\n \"spec\" : {\n \"targetKind\" : \"meshWorkspace\",\n \"key\" : \"workspaceOwner\",\n \"valueType\" : {\n \"string\" : {\n \"defaultValue\" : \"Anna Admin\"\n }\n },\n \"description\" : \"Person responsible for this workspace.\",\n \"displayName\" : \"Workspace Owner\",\n \"sortOrder\" : 9999,\n \"mandatory\" : true,\n \"immutable\" : false,\n \"restricted\" : false,\n \"replicationKey\" : \"owner\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions/meshWorkspace.workspaceOwner\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions?page=0&size=2\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions?page=0&size=2\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions?page=1&size=2\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions?page=2&size=2\"\n }\n },\n \"page\" : {\n \"size\" : 2,\n \"totalElements\" : 5,\n \"totalPages\" : 3,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Tag Definitions"
],
"summary": "Create tag definition",
"description": "Create a new meshTagDefinition\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTagDefinitionPost",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectroles486549215"
},
"examples": {
"meshTagDefinitionPost": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshTagDefinition\",\n \"metadata\": {\n \"name\": \"meshProject.environment\"\n },\n \"spec\": {\n \"targetKind\": \"meshProject\",\n \"key\": \"environment\",\n \"valueType\": {\n \"singleSelect\": {\n \"options\": [ \"dev\", \"test\", \"qa\", \"production\" ],\n \"defaultValue\": \"dev\"\n }\n },\n \"description\": \"The environment the project runs in.\",\n \"displayName\": \"Environment\",\n \"sortOrder\": 9999,\n \"mandatory\": true,\n \"immutable\": false,\n \"restricted\": false\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTagDefinitionPost"
},
"examples": {
"meshTagDefinitionPost": {
"value": "{\n \"kind\" : \"meshTagDefinition\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"meshProject.environment\"\n },\n \"spec\" : {\n \"targetKind\" : \"meshProject\",\n \"key\" : \"environment\",\n \"valueType\" : {\n \"singleSelect\" : {\n \"options\" : [ \"dev\", \"test\", \"qa\", \"production\" ],\n \"defaultValue\" : \"dev\"\n }\n },\n \"description\" : \"The environment the project runs in.\",\n \"displayName\" : \"Environment\",\n \"sortOrder\" : 9999,\n \"mandatory\" : true,\n \"immutable\" : false,\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions/meshProject.environment\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshtenants": {
"get": {
"tags": [
"Tenants"
],
"summary": "List tenants",
"description": "List all meshTenants with filtering and pagination support\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTenantListV",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for meshTenants that belong to the meshWorkspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "projectIdentifier",
"in": "query",
"description": "Filter for meshTenants that belong to the meshProject with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "platformIdentifier",
"in": "query",
"description": "Filter for meshTenants that belong to the meshPlatform with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "deletionState",
"in": "query",
"description": "Filter for meshTenants with a certain deletion state. Possible values are: [ACTIVE](default option) All meshTenants that are not deleted or submitted for deletion,[MARKED_FOR_DELETION] All meshTenants that are awaiting manual deletion approval, or [DELETED] All meshTenants that are deleted or submitted for deletion",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "platformTypeIdentifier",
"in": "query",
"description": "Filter for meshTenants that belong to the platform type with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "landingZoneIdentifier",
"in": "query",
"description": "Filter for meshTenants that belong to a certain landing zone. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "platformTenantId",
"in": "query",
"description": "Filter for meshTenants with a given platformTenantId. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "Filter for meshTenants with a certain state. You can also filter for multiple states by providing the state parameter multiple times. Possible values are: +\n[ACTIVE](default option) All meshTenants that are not deleted or submitted for deletion. +\n[MARKED_FOR_DELETION] All meshTenants that are awaiting manual deletion approval or are pending deletion. +\n[DELETED] All meshTenants that are successfully deleted in cloud platforms.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtenant.v3.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshtenant.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTenantListV3"
},
"examples": {
"meshTenantListV3": {
"value": "{\n \"_embedded\" : {\n \"meshTenants\" : [ {\n \"kind\" : \"meshTenant\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"ownedByProject\" : \"test-project\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"platformIdentifier\" : \"aws.aws-meshstack-dev\",\n \"deletedOn\" : \"2026-06-04T14:05:46.268698474Z\",\n \"assignedTags\" : { },\n \"tenantIdentifier\" : \"test-workspace.test-project.aws.aws-meshstack-dev\"\n },\n \"spec\" : {\n \"localId\" : \"c61f8950-301b-48c4-98cb-08e71926005b\",\n \"landingZoneIdentifier\" : \"stage-dev\",\n \"quotas\" : [ {\n \"key\" : \"limits.cpu\",\n \"value\" : 2000\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 10000\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/test-workspace.test-project.aws.aws-meshstack-dev\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=test-workspace&projectIdentifier=test-project&platformIdentifier=aws.aws-meshstack-dev\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&deletionState=MARKED_FOR_DELETION&page=0&size=1\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&deletionState=MARKED_FOR_DELETION&page=0&size=1\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&deletionState=MARKED_FOR_DELETION&page=1&size=1\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&deletionState=MARKED_FOR_DELETION&page=1&size=1\"\n }\n },\n \"page\" : {\n \"size\" : 1,\n \"totalElements\" : 2,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshtenant.v4-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTenantListV4"
},
"examples": {
"meshTenantListV4": {
"value": "{\n \"_embedded\" : {\n \"meshTenants\" : [ {\n \"kind\" : \"meshTenant\",\n \"apiVersion\" : \"v4-preview\",\n \"metadata\" : {\n \"uuid\" : \"b9b172ad-a848-4dc1-8e09-fdff8adb5003\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"ownedByProject\" : \"test-project\",\n \"createdOn\" : \"2026-06-03T14:05:47.226906155Z\"\n },\n \"spec\" : {\n \"platformIdentifier\" : \"sr.eu-de-netde\",\n \"landingZoneIdentifier\" : \"stage-dev\",\n \"platformTenantId\" : \"bfb96178-ea6f-4648-a6cc-22f4f5d130af\",\n \"quotas\" : [ {\n \"key\" : \"limits.cpu\",\n \"value\" : 2000\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 10000\n } ]\n },\n \"status\" : {\n \"tenantName\" : \"test-workspace.test-project.sr.eu-de-netde\",\n \"platformTypeIdentifier\" : \"SERVICEREGISTRY\",\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/b9b172ad-a848-4dc1-8e09-fdff8adb5003\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=test-workspace&projectIdentifier=test-project&platformIdentifier=sr.eu-de-netde\"\n }\n }\n }, {\n \"kind\" : \"meshTenant\",\n \"apiVersion\" : \"v4-preview\",\n \"metadata\" : {\n \"uuid\" : \"b8f22f9e-c68a-4673-ba45-88771c13bb7e\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"ownedByProject\" : \"test-project\",\n \"createdOn\" : \"2026-06-03T14:05:47.221197256Z\"\n },\n \"spec\" : {\n \"platformIdentifier\" : \"aws.aws-meshstack-dev\",\n \"landingZoneIdentifier\" : \"stage-dev\",\n \"platformTenantId\" : \"2f3561e8-51f4-451f-bc92-9e5c8c6dd98f\",\n \"quotas\" : [ {\n \"key\" : \"limits.cpu\",\n \"value\" : 2000\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 10000\n } ]\n },\n \"status\" : {\n \"tenantName\" : \"test-workspace.test-project.aws.aws-meshstack-dev\",\n \"platformTypeIdentifier\" : \"AWS\",\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/b8f22f9e-c68a-4673-ba45-88771c13bb7e\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=test-workspace&projectIdentifier=test-project&platformIdentifier=aws.aws-meshstack-dev\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&state=ACTIVE&state=DELETED&page=0&size=2\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&state=ACTIVE&state=DELETED&page=0&size=2\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&state=ACTIVE&state=DELETED&page=1&size=2\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=test-workspace&projectIdentifier=test-project&state=ACTIVE&state=DELETED&page=1&size=2\"\n }\n },\n \"page\" : {\n \"size\" : 2,\n \"totalElements\" : 3,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Tenants"
],
"summary": "Create tenant",
"description": "Create a new meshTenant\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTenantPostV",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtenant.v3.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtenant.v3.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshtenant.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshtenants-1377394246"
},
"examples": {
"meshTenantPostV3": {
"value": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"meshTenant\",\n \"metadata\": {\n \"ownedByProject\": \"test-project\",\n \"ownedByWorkspace\": \"test-workspace\",\n \"platformIdentifier\": \"azure.meshcloud-azure-dev\"\n }, \n \"spec\": {\n \"landingZoneIdentifier\": \"stage-dev\"\n }\n} "
}
}
},
"application/vnd.meshcloud.api.meshtenant.v4-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshtenants-1387214899"
},
"examples": {
"meshTenantPostV4": {
"value": "{\n \"apiVersion\": \"v4-preview\",\n \"kind\": \"meshTenant\",\n \"metadata\": {\n \"ownedByProject\": \"test-project\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"platformIdentifier\": \"azure.meshcloud-azure-dev\",\n \"landingZoneIdentifier\": \"stage-dev\",\n \"platformTenantId\": \"cloud-tenant-4763-4526189\"\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshtenant.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTenantPostV3"
},
"examples": {
"meshTenantPostV3": {
"value": "{\n \"kind\" : \"meshTenant\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"ownedByProject\" : \"test-project\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"platformIdentifier\" : \"azure.meshcloud-azure-dev\",\n \"assignedTags\" : { },\n \"tenantIdentifier\" : \"test-workspace.test-project.azure.meshcloud-azure-dev\"\n },\n \"spec\" : {\n \"landingZoneIdentifier\" : \"stage-dev\",\n \"quotas\" : [ ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/test-workspace.test-project.azure.meshcloud-azure-dev\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=test-workspace&projectIdentifier=test-project&platformIdentifier=azure.meshcloud-azure-dev\"\n }\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshtenant.v4-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTenantPostV4"
},
"examples": {
"meshTenantPostV4": {
"value": "{\n \"kind\" : \"meshTenant\",\n \"apiVersion\" : \"v4-preview\",\n \"metadata\" : {\n \"uuid\" : \"1ef54f79-00b0-47cf-ab41-d4c3969e1a60\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"ownedByProject\" : \"test-project\",\n \"createdOn\" : \"2026-06-03T14:05:47.906477935Z\"\n },\n \"spec\" : {\n \"platformIdentifier\" : \"azure.meshcloud-azure-dev\",\n \"landingZoneIdentifier\" : \"stage-dev\",\n \"platformTenantId\" : \"cloud-tenant-4763-4526189\",\n \"quotas\" : [ ]\n },\n \"status\" : {\n \"tenantName\" : \"test-workspace.test-project.azure.meshcloud-azure-dev\",\n \"platformTypeIdentifier\" : \"AZURE\",\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/1ef54f79-00b0-47cf-ab41-d4c3969e1a60\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=test-workspace&projectIdentifier=test-project&platformIdentifier=azure.meshcloud-azure-dev\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshusers": {
"get": {
"tags": [
"Users"
],
"summary": "List all users",
"description": "Provides a paged list of meshUsers. Deleted meshUsers are not provided via this endpoint.\n\n**Note**: In order to filter on WorkspaceUserGroups you must only specify the workspaceUserGroup\nIdentifier and none of the other request parameters.\n\nIn case you filter on roles the response contains all meshUsers with that role regardless if they\nhave been assigned directly or via a group. This offers for example a great opportunity to find the\n(contact) information of all Workspace Managers within one request, whereas the upcoming endpoints\nfor the bindings (i.e. meshWorkspaceUserBinding, meshWorkspaceGroupBinding etc.) are not sufficient\nfor this use-case. For that purpose several requests are required to cover direct user bindings and\nbindings via groups.\n\nNote: Filtering on projects with the projectIdentifier requires a workspaceIdentifier,\nas a projectIdentifier is only unique within a meshWorkspace.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshUserListV2",
"parameters": [
{
"name": "uuid",
"in": "query",
"description": "Filter for meshUsers by their unique identifier (UUID) (optional). If specified, you will receive at most one user (the only user with that given UUID)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for meshUsers assigned to the meshWorkspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "projectIdentifier",
"in": "query",
"description": "Requires workspaceIdentifier. Filter for meshUsers having access to the meshProject of a certain workspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "platformIdentifier",
"in": "query",
"description": "Filter for meshUsers having access to a meshTenant which exist on the platform with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceRole",
"in": "query",
"description": "Filter for meshUsers with given workspace role name, e.g Workspace Manager. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "projectRole",
"in": "query",
"description": "Filter for meshUsers with an active role by the given project role name. By default the following roles are used: \nProject Admin, Project User and Project Reader. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "firstName",
"in": "query",
"description": "Filter for meshUsers based on their first name. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "lastName",
"in": "query",
"description": "Filter for meshUsers based on their last name. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "username",
"in": "query",
"description": "Filter for meshUsers based on their username. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "email",
"in": "query",
"description": "Filter for meshUsers based on their E-mail. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "euid",
"in": "query",
"description": "Filter for meshUsers based on their unique EUID (optional). If specified, you will receive at most one user (the only user with that given EUID)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshuser.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshUserListV2"
},
"examples": {
"meshUserListV2": {
"value": "{\n \"_embedded\" : {\n \"meshUsers\" : [ {\n \"kind\" : \"meshUser\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"uuid\" : \"8834a53b-f903-4266-92ad-6c224beaf54b\",\n \"name\" : \"john-doe\"\n },\n \"spec\" : {\n \"email\" : \"jdoe@example.com\",\n \"firstName\" : \"John\",\n \"lastName\" : \"Doe\",\n \"euid\" : \"7b2b2f62-36aa-413a-b24d-a053b3082bbe\",\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers/john-doe\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?username=john-doe\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=mobile-app&workspaceRole=Workspace%20Manager&page=0&size=1\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=mobile-app&workspaceRole=Workspace%20Manager&page=0&size=1\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=mobile-app&workspaceRole=Workspace%20Manager&page=1&size=1\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=mobile-app&workspaceRole=Workspace%20Manager&page=1&size=1\"\n }\n },\n \"page\" : {\n \"size\" : 1,\n \"totalElements\" : 2,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Users"
],
"summary": "Create user",
"description": "Create a new meshUser.\n\nThis endpoint is only available when SCIM provisioning is disabled for this meshStack and will\notherwise reject all requests. We recommend creating meshUsers using SCIM provisioning from an\nauthoritative IAM system like Entra Id. As an alternative you can provision users via\nmeshObject API using this endpoint.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshUserV2Post",
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshuser.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshusers-username-179515684"
},
"examples": {
"meshUserV2Post": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshUser\",\n \"metadata\": {\n \"name\": \"new\"\n },\n \"spec\": {\n \"email\": \"new@example.com\",\n \"euid\": \"new123\",\n \"firstName\": \"New\",\n \"lastName\": \"User\",\n \"tags\": {}\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshuser.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshUserV2Post"
},
"examples": {
"meshUserV2Post": {
"value": "{\n \"kind\" : \"meshUser\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"uuid\" : \"37e1e6cd-6fb4-4c22-88a7-0c65278862b7\",\n \"name\" : \"new\"\n },\n \"spec\" : {\n \"email\" : \"new@example.com\",\n \"firstName\" : \"New\",\n \"lastName\" : \"User\",\n \"euid\" : \"new123\",\n \"tags\" : {\n \"environment\" : [ \"dev\", \"test\", \"qa\" ]\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers/new\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?username=new\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshworkspaces": {
"get": {
"tags": [
"Workspaces"
],
"summary": "List workspaces",
"description": "List all meshWorkspaces\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshWorkspaceList",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspace.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspace.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceList"
},
"examples": {
"meshWorkspaceList": {
"value": "{\n \"_embedded\" : {\n \"meshWorkspaces\" : [ {\n \"kind\" : \"meshWorkspace\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"admin-customer\",\n \"tags\" : { },\n \"createdOn\" : \"2026-06-03T14:04:11Z\"\n },\n \"spec\" : {\n \"displayName\" : \"admin-customer\",\n \"platformBuilderAccessEnabled\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/admin-customer\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=admin-customer\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=admin-customer\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=admin-customer\"\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=admin-customer\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?workspaceIdentifier=admin-customer\"\n }\n }\n }, {\n \"kind\" : \"meshWorkspace\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"demo-customer\",\n \"tags\" : { },\n \"createdOn\" : \"2026-06-03T14:04:11Z\"\n },\n \"spec\" : {\n \"displayName\" : \"demo-customer\",\n \"platformBuilderAccessEnabled\" : true\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/demo-customer\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=demo-customer\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=demo-customer\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=demo-customer\"\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=demo-customer\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?workspaceIdentifier=demo-customer\"\n }\n }\n }, {\n \"kind\" : \"meshWorkspace\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"demo-partner\",\n \"tags\" : { },\n \"createdOn\" : \"2026-06-03T14:04:11Z\"\n },\n \"spec\" : {\n \"displayName\" : \"demo-partner\",\n \"platformBuilderAccessEnabled\" : true\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/demo-partner\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=demo-partner\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=demo-partner\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=demo-partner\"\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=demo-partner\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?workspaceIdentifier=demo-partner\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"first\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces?page=0&size=3\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces?page=0&size=3\"\n },\n \"next\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces?page=1&size=3\"\n },\n \"last\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces?page=1&size=3\"\n }\n },\n \"page\" : {\n \"size\" : 3,\n \"totalElements\" : 6,\n \"totalPages\" : 2,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Workspaces"
],
"summary": "Create workspace",
"description": "Create a new meshWorkspace\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshWorkspacePost",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspace.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspace.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshworkspace.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshworkspaces-1513610107"
},
"examples": {
"meshWorkspacePost": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshWorkspace\",\n \"metadata\": {\n \"name\": \"my-workspace\",\n \"tags\": {\n \"costCenter\": [\"4058\"],\n \"workspaceOwner\": [\"Anna Admin\"]\n }\n },\n \"spec\": {\n \"displayName\": \"My Workspace\",\n \"platformBuilderAccessEnabled\": true\n }\n}"
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshworkspace.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspacePost"
},
"examples": {
"meshWorkspacePost": {
"value": "{\n \"kind\" : \"meshWorkspace\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"my-workspace\",\n \"tags\" : {\n \"costCenter\" : [ \"4058\" ],\n \"workspaceOwner\" : [ \"Anna Admin\" ]\n },\n \"createdOn\" : \"2026-06-03T14:05:51.822610168Z\"\n },\n \"spec\" : {\n \"displayName\" : \"My Workspace\",\n \"platformBuilderAccessEnabled\" : true\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/my-workspace\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=my-workspace\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=my-workspace\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=my-workspace\"\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=my-workspace\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?workspaceIdentifier=my-workspace\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshworkspaceusergroups": {
"get": {
"tags": [
"Workspace User Groups"
],
"summary": "List workspace user groups",
"description": "List all meshWorkspaceUserGroups with optional filtering and pagination\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshWorkspaceUserGroupList",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number (default=0). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "size",
"in": "query",
"description": "The amount of elements in a single page (default=50). Information about [paging](/api/technical-specifications/#paging)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for meshWorkspaceUserGroups that belong to the meshWorkspace with given identifier. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "username",
"in": "query",
"description": "Filter for meshWorkspaceUserGroups that belong to the meshUser with given username. (optional)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspaceusergroup.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspaceusergroup.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceUserGroupList"
},
"examples": {
"meshWorkspaceUserGroupList": {
"value": "{\n \"_embedded\" : {\n \"meshWorkspaceUserGroups\" : [ {\n \"kind\" : \"meshWorkspaceUserGroup\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"my-user-group\",\n \"ownedByWorkspace\" : \"sample-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My User Group\",\n \"egid\" : \"e74b9db5-7ac5-42a8-bef9-9f7f0c2738ca\",\n \"members\" : [ \"sample-user\" ],\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups/sample-workspace.my-user-group\"\n },\n \"meshworkspace\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/sample-workspace\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceUserGroupIdentifier=my-user-group\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?username=sample-user&page=0&size=3\"\n }\n },\n \"page\" : {\n \"size\" : 3,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/metadata/openstackProjectMetadata": {
"post": {
"tags": [
"Openstack Metadata"
],
"summary": "Retrieve OpenStack project metadata",
"description": "Retrieve project metadata information for OpenStack projects using project ID\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "openStackProjectMetadata",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/api-metadata-openstackProjectMetadata-1305671199"
},
"examples": {
"openStackProjectMetadata": {
"value": "\n {\n \"project-id\": \"d3fc4451-f555-44f2-b651-c8062d21d0e3\"\n }\n "
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/openStackProjectMetadata"
},
"examples": {
"openStackProjectMetadata": {
"value": "{\n \"project-identifier\" : \"test-project-identifier\",\n \"project-display-name\" : \"test-project\",\n \"customer-identifier\" : \"test-customer-identifier\",\n \"customer-display-name\" : \"test-customer\",\n \"tags\" : {\n \"costCenter\" : [ \"1235\" ],\n \"customNumber\" : [ \"1645789\" ]\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshapikeys/{uuid}": {
"get": {
"tags": [
"API Keys"
],
"summary": "Get API key",
"description": "Get a single meshApiKey by metadata.uuid (which equals the Keycloak clientId).\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshApiKey-Get",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The meshApiKey UUID (Keycloak clientId).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshApiKey-Get"
},
"examples": {
"meshApiKey-Get": {
"value": "{\n \"kind\" : \"meshApiKey\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\",\n \"ownedByWorkspace\" : \"apikey-workspace\",\n \"createdOn\" : \"2026-06-03T14:05:01.977263448Z\"\n },\n \"spec\" : {\n \"displayName\" : \"temporary-api-key\",\n \"permissions\" : [ \"BUILDINGBLOCK_LIST\" ],\n \"expiresAt\" : \"2026-07-03\"\n },\n \"status\" : {\n \"clientId\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshapikeys/623db4e9-8b3e-4edf-8828-8cda5e96befe\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"API Keys"
],
"summary": "Update API key",
"description": "Update an existing meshApiKey. If the UUID does not exist, the API returns 404. When expiresAt changes, the secret is rotated and the new clientSecret is included in the response.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshApiKey-Put",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The meshApiKey UUID (Keycloak clientId).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshapikeys-uuid-543980870"
},
"examples": {
"meshApiKey-Put": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshApiKey\",\n \"metadata\": {\n \"uuid\": \"623db4e9-8b3e-4edf-8828-8cda5e96befe\",\n \"ownedByWorkspace\": \"apikey-workspace\"\n },\n \"spec\": {\n \"displayName\": \"temporary-api-key-updated\",\n \"permissions\": [\"BUILDINGBLOCK_LIST\"],\n \"expiresAt\": \"2026-07-18\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshApiKey-Put"
},
"examples": {
"meshApiKey-Put": {
"value": "{\n \"kind\" : \"meshApiKey\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\",\n \"ownedByWorkspace\" : \"apikey-workspace\",\n \"createdOn\" : \"2026-06-03T14:05:01.977263448Z\"\n },\n \"spec\" : {\n \"displayName\" : \"temporary-api-key-updated\",\n \"permissions\" : [ \"BUILDINGBLOCK_LIST\" ],\n \"expiresAt\" : \"2026-07-18\"\n },\n \"status\" : {\n \"clientId\" : \"623db4e9-8b3e-4edf-8828-8cda5e96befe\",\n \"clientSecret\" : \"LbAhw7aWBVSLLFjmdKNPayMbYrarH1dT\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshapikeys/623db4e9-8b3e-4edf-8828-8cda5e96befe\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"API Keys"
],
"summary": "Delete API key",
"description": "Delete an existing meshApiKey by UUID.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshApiKey-Delete",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The meshApiKey UUID (Keycloak clientId).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshapikey.v1-preview.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockdefinitions/{uuid}": {
"get": {
"tags": [
"Building Block Definitions"
],
"summary": "Get building block definition",
"description": "Retrieve detailed information about a specific meshBuildingBlockDefinition including versions and metadata\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionV1",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshBuildingBlockDefinition.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionV1"
},
"examples": {
"meshBuildingBlockDefinitionV1": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"ownedByWorkspace\" : \"my-workspace\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"4kkx3mbbdds1\",\n \"symbol\" : \"my-image\",\n \"targetType\" : \"TENANT_LEVEL\",\n \"description\" : \"description\",\n \"supportedPlatforms\" : [ {\n \"name\" : \"AZURE\",\n \"kind\" : \"meshPlatformType\"\n } ],\n \"runTransparency\" : false,\n \"useInLandingZonesOnly\" : false,\n \"supportUrl\" : \"https://example-support.com\",\n \"documentationUrl\" : \"https://example-docs.com\",\n \"notificationSubscriberUsernames\" : [ ]\n },\n \"status\" : {\n \"versions\" : [ {\n \"versionUuid\" : \"2ed7a604-913e-4b75-b9fb-5d6aa3618819\",\n \"versionNumber\" : 1,\n \"state\" : \"RELEASED\"\n } ],\n \"latestVersion\" : 1,\n \"latestVersionUuid\" : \"2ed7a604-913e-4b75-b9fb-5d6aa3618819\",\n \"latestReleasedVersion\" : 1,\n \"latestReleasedVersionUuid\" : \"2ed7a604-913e-4b75-b9fb-5d6aa3618819\",\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:03.007548547Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/b23cfb9a-6974-444f-9d33-62134a632373\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/my-workspace\"\n },\n \"buildingblocks\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks?definitionUuid=b23cfb9a-6974-444f-9d33-62134a632373\"\n },\n \"versions\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=b23cfb9a-6974-444f-9d33-62134a632373\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Building Block Definitions"
],
"summary": "Update building block definition",
"description": "Update an existing meshBuildingBlockDefinition with new configuration details\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionPutV1",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockdefinitions-uuid1057849355"
},
"examples": {
"meshBuildingBlockDefinitionPutV1": {
"value": "{\n \"apiVersion\" : \"v1-preview\",\n \"kind\" : \"meshBuildingBlockDefinition\",\n \"metadata\" : {\n \"uuid\": \"ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\",\n \"ownedByWorkspace\": \"my-workspace\"\n },\n \"spec\" : {\n \"targetType\": \"TENANT_LEVEL\",\n \"displayName\": \"BB definition example\",\n \"description\": \"description - updated\",\n \"supportUrl\": \"https://example.com\",\n \"documentationUrl\": \"https://example.com\",\n \"supportedPlatforms\" : [ { \"kind\": \"meshPlatformType\", \"name\": \"AZURE\" } ],\n \"useInLandingZonesOnly\": false,\n \"runTransparency\": false,\n \"notificationSubscriberUsernames\": []\n } \n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionPutV1"
},
"examples": {
"meshBuildingBlockDefinitionPutV1": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\",\n \"ownedByWorkspace\" : \"my-workspace\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"BB definition example\",\n \"symbol\" : \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAxAAAAJpCAYAAAA9o9RAAAAACXBIWXMAAC4jAAAuIwF4pT92AAAgAElEQVR4nOzdPW8kV7bu+R2ZyUy+1Vt3o+cAF1MtQ8aMpRqTliRrxtBAZYyvupgP0PUNVP0JbrU3XpfGGu+qgQLGpHQdmUfyrlHAkQQMoBakqmS9kEySGTF4InewslhkMjJzR8TaEf/fvQSlPt1kMpLJ3E/stdZOsixzAAAAAFBGj6sEAAAAoCwCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEojQAAAAAAojQABAAAAoDQCBAAAAIDSCBAAAAAASiNAAAAAACiNAAEAAACgNAIEAAAAgNIIEAAAAABKI0AAAAAAKI0AAQAAAKA0AgQAAACA0ggQAAAAAEobcKkAAIjP3v74nnPutn/g8/+8rLFz7nv/vxl/9+nt7/l1ALBIkmUZFwgAAGP29se3fTAowsEn/vNHNT3SH+bCRfH5RwIGAAIEAAANmNtB+MA59z855/7N/7MCwq7xKgGFix99qPhGn7/79PbYwOMCUAMCBAAAFZnbRfjEh4MP/L/fauE1/8mHiSJQsFMBtBQBAgCAQPyuwif+Q//8lw5f2wPn3NdFqPju09s/GnhMAAIgQAAAsCK/w3Dff3zS0p2FUH7wgeJrdieAuBEgAABYwt7++AMfGB7U2NDcNj/5MPGEMAHEhwABAEAJe/vjBz44fM71Cko7E098mKARG4gAAQIAgCv43QYFh4eUJ9XiKx8kvunAzwpEiwABAMAFPjg8cs59wbVphEqcHn336e0nHfzZAfMIEAAAeAQHczTJ6bE+KG8C7CBAAAA6z09TUpnSl12/FkYRJABDCBAAgE7b2x/f94vTLp/ZEAuCBGAAAQIA0El+1+FJ41OVes5lSXLl/zlJM+dCvVUnzmW9d79XonVAGujr14ceCaBBBAgAQOfs7Y8/8eGhvl2HXuKyvv/cm312V+eG9+ntOs1ckvrP02sW/vo+g2QWUPolvlfx9af+81kU64NvfZBgahNQIwIEAKBT9vbH6nX4L3X8zPkCfpCUW8Cv9A3cLEic+QW/wsJGb/Z91/1+xdc+9WHFtq98kPjR+gMF2oAAAQDojL398ZPKJyxpET/sVRcarpK56r7fNHPJifkgceB7Ix4ZeCxAqxEgAACdUHl46CUuHSXO9etMDfVKtBtxkobryaiG+iMefvfp7a8juKRAlAgQAIDWqzQ8JH7HYaO9weEdaeZ6R+ZDhPP9EQoS3xt4LECrECAAAK1WaXjQrsNWr95SJQviCRHO90c8ZOwrEE6PawkAaKu9/XFlp0prxyHd7mB4cH7C0zCaJYSe/x998zyAANiBAAC0kh/Vul/Fz6bwkI24B5ccpTFMaJqn/ogHjH0F1kOAAAC0jj8kTiM9b4X+2TRdKdsiPIhGxybH8Z1C5/sjHjD2FVgNfwEBAG30qIrwkDdMb/LWWcjinTj1sXPuP1Ti5sMmgCWwAwEAaJW9/fEHWhxW8TPl05aGXWx6uFrv9dTqQyvrwDdZP4nj4QLNI0AAAFrDh4f/5pz7H6v4mdKdfjebpq8y9dOY2uEHHyTojwCuQYAAAETPl6Foys6XVf0s9D68L5mk+eFyLfNPHyTojwCuQIAAAERtb3/8wDn3uJKehzlMXrpAZ0Ectmb34aID/zv1mPMjgPcRIAAAUfJjWrXI+6iOx0//w5y4DpJbh8a+PqI/AngXAQIAEBXf56Dg8Hmdj5sA4anv4bgT4WHetz5I0B+BznMECABALOroc1gkGyTdHuGaOZectLLnYRlf+f4IyprQaQQIAIB5dfU5LJT4KUxdo+BwmrnktHO7Dlc58L0Rj2w+PKB6BAgAgFl19zlcRzsQ2onoivyk6ZPUudb2Sq/lJ78b8XXEPwOwEgIEAMCcpvocFtIOhMa49joQINLMJZPMJVPWCCWoP+IBY1/RJQQIAIAZTfc5XKkr4aGBPofJ9NSN+hu1fb8K/d03WtMfgdYjQAAATDDR53CZjoSH5KSZPocWBQjn+yMUIh4beCxAZQgQAIBGWetzuEiHx+kQudbSWNZJc30OLQsQhZ98WRNjX9FKBAgAQCNM9jlc1HMu3W7p5CWVKx2njfc5HJ5N3PZg1OhjqNA/faM1/RFoFQIEAKBWZvscLtHK3Qdj5zm8OjlyN4ZbBh5Jpf7mR7/SH4FW6PCJOACAuvk+h++rCg9pFrYOJ2vZu6TGsvYOp2bCw2l65rJuHC6h3/cf/e8/ED12IAAAlfN9Djp46+Mqv9fRdOK2+uHKYfLm6X4LdiDyPocsH89qyavTQ6dlyM3htqnHVbEffFkT/RGIFgECAFAZ3+eg4PBFHVf5xeSVuzO6EezrRR8gVK40SfOdB4t+OXyR9z90LEAUvvITm+iPQHQIEACA4Ob6HB7WOZb1t+MDd2NjO9hUn2hPnlZwOPWnSBt1PD1xvx+/zJ+vjgYI58e+PqY/ArGhBwIAENSFPofaz3RQWUwwEZ7EnPc5HE1Nhwd5fXpk4FE07pZ/nXxPfwRiwg4EACCIuvocFtEOhM4V+OPmTbfZHwb5mulOPz9MzrxpNjsMLoLQo9GtKjeTju9AXPSt74/43tbDAt5FgAAArKXuPodFigDRT/ruz1u3XS8JsPLvJS7dNrxhb2ws63XSLHP/Onqef3YEiKt85YMEZU0wiQABAFhJU30OixQBQrQDoZ2IEHQWhM6EsCbfcThNXUyTUNX3oP6HAgHiSge+N+KR0ceHDiNAAACW5uu1tbD5i6WrNx8gRBOZQp1ynIeIYc9EOZP6HPIeB9ttDu9R38PByZt3/mMCxLV+cs49YOwrLCFAAABKs9DnsMjFACF/2rwVbCpTXs60meSfG5FmLpnE0edwkZ4XPT8XESBK+9YHCca+onEECADAtSz1OSxyWYBQH4RCxEZvEOz71L4bEVmfw0U6cVrPTXrJmoMAsbS/+/Mj6I9AYwgQAIArWexzWOSyAOEqChEKDzojotIgUZznEFmfw7xF4cERIFZ14EPE4zgfPmJHgAAAXMpqn8MiVwUI50OEeiJCjXe98MVnuxJ9t355k0KDSpQ0llUnSEf8Nq1maY1rvSo8OALEun7w05roj0CtCBAAgHdY73NYZFGAKNwa7rjdja3qHoR2Jvq+T6LnXNZbECoy39eQzj6rKTrG/obLXNYwfRkCRBD/9EGC/gjUggABAMjF0uewSJkAIduDzTxIBDknAu/QboOCw+HZcakLQ4AI6m9+9Cv9EagUAQIAOi62PodFygYI0WFzd0a74SY0Ie93+P34lZtm09IXgwAR3IHfjXjSsp8LhhAgAKDDYuxzWGSZAFFQOZMWsexGrE67Dm/OjtzLk8OlvwYBojLf+kZr+iMQHAECADoo5j6HRVYJEM7vRtwe7VTTYN1yapQeT94steswjwBRua98kKA/AsEQIACgQ9rQ57DIqgGioHImLWgpa7qervOr08O1rrcjQNRFZU2P6Y9AKAQIAOiANvU5LLJugCgQJK4WKjgUCBC1+sn3R3zdoZ8ZFSBAAEDLta3PYZFQAaKgAKGJTduDUUWPOB6HZ5N8slLI6+sIEE351geJ77v542NdBAgAaKm29jksEjpAFNQjsbMxysNEP+kF//pWTbM0Dw1vTicr9zhchwDRqK98kKCsCUshQABAy/hypcdt7XNYpKoAMW+jN8gnN6nhuo2TmzRRSY3RVew2XIYA0bgD32T9uOPXAUsgQABAi+ztjx+1vc9hkToCxDyFCZU3qdRJ/xwrnd+g66bgUOf1cwQIS9Qf8YCxryiDAAEALbC3P77vdx1a3+ewSN0BYp52Izb7I7fR65sPFAoMp+k0v1b6qKo8qQwChDnf+iDB2FdciQABABHb2x/f88GhM30OizQZIC5TBAl9qHeiialOs4CQ+tAw+0gNvfcTIMz6uy9toj8C7yFAAECEfJ/D/+2c+995/t6yFiAuo50KBYrEJW7Yn+1SFP9e0L8v6q9QAFAQKGTu7b+fTM/O/91SULgKAcK0A99k/aTrFwLvIkAAQAT8RKV7/uN/c879Dzxv74shQOBdBIgo/OCDBP0RyBEgAMAgHxiKD8qTSiJAxIcAEZV/+iBBf0THESAAwABfknTff3zS1SlK6yJAxIcAEaW/qfeK/ojuIkAAQIP8KdEKDZ/zPKyPABEfAkS0fvJN1vRHdBABAgBqtrc//sCfEH2fnYawCBDxIUBE71sfJOiP6BACBADUxPc1PKKnoToEiPhotO2fNsnRLfCVDxL0R3QAAQIAKkZwqA8BIk7/aedPXb8EbXHgeyMedf1CtB0BAgAqQnCoHwEiTtqBaOKQPVTmJz+t6WsucTsRIAAgMD9RSadDf8G1rRcBIk63hjtud2Or65ehjb71QeL7rl+Itul1/QIAQEh7++OHzrkfCQ9AeTGcmI2VaPf13/f2x4/9jRW0BDsQABCAf3N80sg41l7issQ510/8v7vZv18hmfr/PM1cks4+l5Y4l/WS2e2nJLn0e+VfM1vx66+JHYg4MYmpEw58k/Xjrl+INiBAAMCa9vbH95xz39Q1kjVTUOgnLuvPhYZ1Tf1iX5/PLrwvKKBs+O/XW+H7ZQot2duvXeHbzu/HL93x9KS6b4BKECA6Rf0RDxj7GjcCBACswR8E94/Kr6EW8cNkFh4CZYYrzS34s0ESLqS4t187OUmdS0M/cOdenhy6V6eH4b8wKkWA6KRvfZBg7GuECBAAsKK9/bEmLH1Z5fXL7/xvJKvd+TcuOfFBIiACRJwIEJ32Nz/6ddz1CxETAgQArGBvf/ykykZp7TRkm73qdxualmaudxxuN0LlSypjQlyiHOPa82V9if/sSpYUFv1B+eeifPD60r5897E3+x5531Hvit3I+a+vrz2ttw9pRQd+WtMT6w8UMwQIAFiSJoo45/5ayXVTk/KoNysd6orMud5RGmSRM82m7pfDF925di3xb9t3XD/p2/5h9NocFP1HFZQSprPFfnKanb8W8u+zEeD7nZcOZtbDxA8+SNAfYRwBAgCWUGnPQy9x6VYHdh0uo50IhYgAb0m/HD5306yCBgtUop/03L9t/8Hsxc1DwyCpN9QXr4MqvqUPEnmfk13/9EGC/gijCBAAUJKftvTvlVyvLocHT3dek8n6C/+Dkzfu9elRoEeFqukAOR0kZ03efzRs72tSE9Hy15vdZeCBP5CT/giDOEgOAErw5zx8Xcm1IjzkZs3i63+d3Y3NEA8HNbH2fKlcKN3u5aWEbX5Nakcl/7tjd0DDLT+k4nu/8wtDCBAAUI7uhP0l+LVKHOFhTjZY/21JtfTRNeR2lJ4nS70Pef+R7UV1WMXNC9urQf3d/cfe/vgbvwsMAyhhAoBr7O2PP3HO7VdxnfIFywbpoRBqtKtOo9ap1LDNzPSlIsh3JThcpB6kw2j6hr7y/RGUNTWIHQgAWMCHh/+3kmuUOMJDRbQo3ewPW/mztYWeH8KDET3f7xEHjc/+0Z/Dg4awAwEAl9jbH3/gnNNM8o+ruj55k+aI+zjzkuM0b+4MQSNdfz0au5T3OXN6SeL+vHXbRPmS+h06HR4KGqf8ZmrjsZT3k9+NqKY/DVciQADAHN8s/aiycx7m6KC4Tp33cJ0KyigOz47di8nrKh4t1nBntOu2B803T+uuezbkNVhIjlLr412v8q1z7gFjX+tDgAAAb29//NCHh1t1XJO8bKLMybVdEPAwuYteTF65w7NJ16+wGduDkbszutH8w+lp98H44XU1izhAFP6uv+H0R1SPAAGg83yfw5NKpiwtQIDwKgwPBZUynaZnlX19lLPRG+SlSxYwwOB9+Q6g7ZOqyzjwIeKx/YcaLwIEgM6qo89hEQJEfYdZqQ9CU5kIEc1ReNDUJfU/WJDu9BmfPC/OHohFfvJlTd/YfYjxIkAA6Jw6+xwW6fQd0FTBIau1XIIQ0Rxr4UHSXcqX5rWgfOkq//SN1vRHBESAANApdfc5LKITb/NDq7okc/k5D8lpM+89ChHPJy/zcyJQD4vhoZOvvQW0C9jUa7JGf9OBoPRHhEGAANAJTfU5XKdLZRT5IXGn1ZcrlUFjdT3MNExfpBOYtwkQTQf6Bhz43YgnXfmBq0KAANBqTfc5XCnxJUxdGOM6zVxPfQ41HXSbZqnrJdcvDjXi9eDkDedEVEC7DbeGOyZGtV6l8yVMNb8ujfnBBwn6I1ZEgADQSlb6HK7SicOrMn8wXM111epxUNlM2f+uzomgLyIcXXud81D2OWhKZw+Qa+h1adRXfmIT/RFLIkAAaB1LfQ6XaX3zdMNlESfpmRsuuXh9eXLo3pwdsRuxphsb2+7mcDuKx9q5k+C7V65UlsqaHtMfsRwCBIDWsNrnMK/tzZtanGiR0mSfgxqkR/2Npf9302zqxpM37nh6UsnjajNdb+069JN4yoK6FCDqGpccuZ98WdPXXb8QZRAgAETPbJ/DJbLNlvY95PXUWeOHUE2z1J2l05UCREEB5NXpIZOaSlCZknod1rneTehMeDDyuozMtz5IfN/1C7EIAQJAtKz3OVymdY2bmR8BeWbjvUSTlfpJL8iCliBxNQWH3Y1N003SV+lEeGjodakA3y8xwCASX/kgQVnTJQgQAKJkvc/hUm0aHZnNlSsZooZojQ4NeUdcAeL16RGlTb5USX0Ose04nGv7+NaGX5erlg8aduB7Ix616YcKgQABICp19zlo0bjZHwb5Wm3pf8jrqU/sjX9UA/S/jp67P4xuVrKIUY/Em9NJPv5Vd1q7QiNZtdOgHYeYehwuk+r112/nAAMLr8uQfy+NUX/EA8a+vkWAABCFpvocfjs+yE/RDSLxB8fFaprNDoMzOv5R5Us6IE7PV9V3QbVQOjqb5J/bOLlJoUELwa3BqLEFodYnScjTq3sa3drCsx8MvS51rop6YlrsWx8kOj/21faQZgCd13Sfg7bkg9X1Zv4jthugkYx/1CjWumhRXSysFSL0e6JAEfPOhH7Ht3z5l4W7yKnLXD/giyVr286DwddlB/qFdAPrP/b2x3/relkTOxAAzLLQ5/D/vfktX1CF2oXIhj2XDeNZyOR3Nk/tj38sdh+kjh2Iq6jMSYuo4sNyoCiazYsPa+VJp+nUbfTCPabYXnuLWHxd6nf9l8Pn7j/t/MnAo6lFp8uaCBAAzPF9DjrY56OmH5sChPxx82awu7J5GZPxdYzVPofLFL0PRSlRkwHiIj0mnXKtMKHPWmQ1ceq1piYpMOizro0+90KWB1VA12zQ6web6tOGAGH5damJZdoF7FCAKHRyN4IAAcAM3+eg4PC5lcdUBAjdnf3z1u0wiy5NglEzp8W1TKoDp+z2OVzm9+OX70xIshQgrqKdirM0Pf/s8hO035Z/6CyLMrsXWlwP5u7SD3uzn3vQ6+W/s8XnGClA6Jpo6lMIUY9vjeB1+cvhi/z3uYMBQn5wzt3vUm8EPRAAGuf7HFSu9KXVZ0NvjCqR0U7E2tLM9Y5SWyEikj6Hiw59I3NstKjv97Wwb9XIy+A0PndnsBUkuOvufTYy9yMuFsnr8jDv/5kaeCSN0W7593v74wddOcm6G2e4AzBLf3Cdcz9aDg8FLVS1TR+EDxEWapi1OOkdTqMLDyoFOjh5beCRoCoqAQv2msucmQMPy4jldannqM4BBoapUe6/+t691iNAAGiE+hz29sffO+f+EdNhcHqj1N22INKGFwhT//0n9pukL1J40IjdNo5Qxbu0CxGqbySK3/XIXpdvzo66vvtw0X/Z2x8/sfWQwqOECUCtLPY5LKuY9qMTj9eWzRY1yalv8hzUUNOk73mcRtXnME+hQSdOEx66Q8+3elvWLmXKnL3ywUKEr0v1qbD7cKkvfGmuSprGBh/f2tiBAFAL/THd2x9rUsV/xBweCgoRwXYiXD70Pl889N74O49pBYsIHTg18d8j0vCgO9G/Ho0bmWSE5szK1d6E+f6Gygdz2Wwsa2yvyyLI40p6n/vGB4nWIUAAqFxMfQ7LUIgIVp9dyIra5/S8jCGv215lXeFrvvPQcDjNF02x9TnMK8qWKJfopsOz47Dlg0fTaoL6EvT6zF/nJ/EdQMhrsZSP2hoiKGECUBlL5zlURdv3GsN5a7gTfq6+diW0wDnNZtUWiXNZL5nd+rnqe/k7mLHuMFxl/qA4dFfQ8sHU5UE9H+86rLmkSX0Ok6zxALMq7TywC1ia3v/UE3E/ksdbCudAAAiuDX0OheIciOvoYK47o938M8JRmYRKV3T3uawYzoHA9VRfr7vcl7kzuhEmRBQUzgc1BImi5ymiaVAXKTwsej129ByIMr767tPbD+w/zHIoYQIQTNv6HJZR1OYHL2nqMC0gdU2XCQ/ohuA9SEXpoPoQjtYoG7zqa6uUsOhxijQ8FD0PvB5X9kWbRryyAwEgCN/n8DimkaxllN2BmKddCJU0cRd8NavsOsxjB6IdFu1AFHY3tvLXWmV6icv6+cl/Lktmn6+lYQWZLydM21FOqNeknosyZUvsQFzrf/nu09vfG3+M1yJAAFhL2/scVgkQhe3Bprs53Hb9hM3esrSDo7n/64xoJUC0Q5kAIXqu/zC6Gb4HaYHsQpDIA0Ok/QzX0fPwfPKy9GuSAHGtn5xz92If70qxLoCVtKnPoSqzqTHH+V1SfRAkrqZyFDWkM9UFy9IC919Hz/MQUVdwbNuQgqso0HPOQ3B/cc6p1DfqciZ2IAAsxY+je9i2kaxXWWcH4iJ2JN6lO5rH05PgwYEdiHYouwMxT0H9xsZ2rbsRbaRSpVUnLbEDUdqn3316+5tIHut72IEAUFpb+xzqUuxIbPaHbmdjM//cRdMszcuUdC04TRohFb9Xt4a7Yac0dYRej0UZISqnXYhPYr3M7EAAyPleBjf3B+0D/yHadfifnXOdW/GG3IG4qJ/03c7GKN+ZaPuuRLHboMWd7ixXiR2IdlhlB2Kefge0G8HvQjkqIzw4eb12qGcHYin/+btPbz+J6PGeYwcC6BgfFBQM7s19sKPQAJXtqHxHH5rcpDumWuy05SyJIjQcnU3yz0CdFEAm0wOCxDXoP2rUI3/IXHTYgQBazPcrfOI/FBQ+5vleTpU7EFfRzsTWYJgveIa9jajqubVoO0lP/eKt2p2Gq7AD0Q7r7kBcpN8J9Uh0tXRwnsK9dgNfnx4HDw7sQCwtyl4IdiCAltnbH9/zgeE+gSFOekNXDXJRh6wdCX3Mdif6ZnYo1MugJkt9NBkYgDKK39EulQ5epNeqQsPxdEL/kR3qLYwuQLADAbSAH6n60IeGv/CchtPEDkQZChFa/Az7g3xBpH8e9PqVLIiKYKCdBS06itBgdQHCDkQ7hN6BuIx2I7YGo/xzWyc3KeirjLCK3YbLsAOxkjuxnQvBDgQQKV+edN8Hh1Ye4oar5Yt4567sLbi4gL5uQX2Wpu8sLiwHBCAUvX6K11ARJvRaiX1nQq/fWf/RyUqjWFE7VQ18HdNlJ0AAkfG7DY98eKD5GZe6WE5EeRGw2HyYKEoGY+lDmu0KTvPXOeVJUbpPgABQibng8AVXGACqU5TpFX1IKhNU/5FKBhUoqioXLEOPq+g/UmBgt7AV7sX2QxAgAOMIDgDQLJX3TafT90oGtUORuCQPFqJwIdqxWHXYQbFbmLnsvPxI/1nRf4RWiq4MmQABGOV7HNTf8CXPEQDYUyz2lznnpOhHoqwQ83Sz8LtPb/8Yy0UhQAAG7e2PVQ/5mIlKwPJ05xawiuCAK6jagAABYHl+1+Fxk+VKWd83Cyb5Pvwl/4XMudT/V9LMrbVW6yUuK76FyonVqDj/9ef+GShLCzQOCwOA6hAgACP8AXBf17brkPiwoEV834eFUoNG3v6XzrPDNHNJ5j9Pr170Z4NE3Yhvv98yXz/1n8+4u4zFuMMLANUiQAAG7O2PdRLlPyp/JMncIn4QcCyhvp4+D/znzOUL/eR0ttjPhsksrKz6LYvQsZHkGxSzr52yO4FL0WgKANUiQAAN29sfq2Tpr1U+inzxvhE4NCyioKLvt1HB9zv/2v08oCQn6XplVGglhYhVp+AAWJ2mRbX1VG+8xV9XoEF7++MnlfY79BKXjmY7Dm2UB4lB3yXH6ax0CvCYiw804ySlB2kV3316+5uYHm/cZ7UDEas0POgu/ajn0u1ea8PDOf2sW71qdjsAAEs5mVJCuKw0yw7iesTsQACN2NsfV3cwnHYdtnqr9xtESoHJZSlN1gDQIO1AYDnTbPpLbJeMHQigZr5hupLD4dTj0MXwUMhDROCfvZ/wZxIAUJ3J9PS/x3Z52YEAaqSTJv05D8GpUTrb7Phi15duqScilEGv76ZTxj3FpjjtN0r6PdaY4+JslOv481hWPZflfELaVaOV/Xksa5/7gk5gjPLyXp8eESAALKS+h1vBL5Gqd7oeHjztwuRrrkALHU3y4Q0xLrHtGuUL+P6y57HMm/0Pzkco+7NY8nK+9JIXQmGklG4AACAASURBVG82IW3xeSzXfP0zzmQBQjienrhplh7HdjEJEEBNfOnSx1V8t7SC0p2Y6e5tqKlMupP9+vSoq5cySjHsPuQjlQdrno9ymeKsF3/+yvyCvwgOa32/ZO6x+6+dj1Jmkw4eI1yXE+v7CwECqMHe/vh2laVLrZ+01KBhL+JSmI4yGyDyM0x66y/il/2efsFf1dfORylzJgs8zl8pT7vbse5wU/MA1ONhJaVLbnY6M96VXFa2sSLdTWOmeTxmz9fI1uPVQnuoscr92a5AC1+yCkX6+cqVRJUTdR9LhyVsh5f26vQwkkf6PgIEUI8HVX2X2k6XjkRelx34LujOxmZ7L1jLKOxZKqHQDmGbg8M7EjebAhcwRHA3Oz48Z+Wo9yHm/joCBFCxvf3xfefcXyr5LgHfqFtBNdmT8MXYWpQyzjUON4fbZh6nJoJlXRurHDhEsAsRn60BO7bX0Un5LyavbD/Ia/COCFTvk6q+Q0Z+eEs9okfV1WDfGd2o5gsjmO3ByPWTvokLqqlonT0dXSFikwDRRbrRwg7E9Z5PXuYhImYECKB696v6DgkNizPTzPWOppePrAxECxkWM3apbOnWcNfE48vDQ9dLC4uJT2ti9y8uWwNj/UcGHZy8acVocF6VQPWqKV9yrtIFcxR8yVK+81DDGMk7o11GFBp1Y2PbxHOjZunOhwcv1HXYHtCDFItd+sUWOjybtGYsOPtMQEX8qdP/V9XXV03DnVuwKDhobORpvWMjVR6jUqbfj1/W901xLd2l3t3Yav5C9fzZC5gJNF5az+2bs6PoSz7azlIJoUUKD7H3PcxjBwKowN7++JFz7nvn3P9a+fUNdGBaLBSYVK7U1Mx5M4tV5FRvbaU/RbsPmL8gYS6GdpZ2BrzmrLM0wMCatoUHxw4EEJafuPS40rKleUm4u3zmpZlLJlmwE6YXyVy2cJb5reGOS7M0f1NAc7Sw/NPmLRtlZQkjlS8K+VrV4lRjL0/Ts2BfE+GohJDdh8vprIeXJ/Ge93AVAgQQwN7++J4PDh/Xdj0rmLluksqVTtK8ZKkuKpXoX7MoLe56EyKaYSo8FCfC412BX7PqQfr1aMxFNka7gOw+vK8Y1arg20YECGANe/vj2z44fFH3dUw32x8ekpP6+xzkLJ26fv/6chRCRDM0leePmzdtjYvkTJZ35D1KgXcLZ+Vqu+7F5HXQr4vVKcD/cZMR1xdpp+z341dumk1tPbCACBDAinyfw0NVtNR9DfPxiG2+46mxrJN6JiutSyGil/RaM1nDOi0iLe084H3qU6riQEfnJzJpBCah3YY/jG5SunRBW0uWLiJAAEuqvc/hEq1t1lS50nFaS5/DIrp7tMyZD+qJ2Oj18/neTIqpjqa86KwHwoNRNZUbsvNng3aDOBvnLQVb7Y61eddhHgECKGnVPocsy1wScMGTN2q2bf3UQJ/DInojWHbSku6M6u643kBo9AxLgUFNmqanX+Wht7vB5nzXoaaXMCGiWQoPnM8xM81SN568bm2vw1UIEMA11u1zSF3m+iEXFi2rtc5rpRsayXqVk3S1U0IVIP68dTvfvtY2NtanO5xarFgvk9CuWdbFDJGXG2aNHGpJiGgG4WFGu806n6QL5UqXIUAAC4Toc9DdCTV94r0L09jCYxHtPqxbhqSJJFuDYV7SpK+H5UWx63BBfqjjRkcShD8FXj9zkxQiFC4J7NUrJp+ZGl7QEIXWg5PXnS5Z5bcAuETIPgeVMKmkhT+6npGFx1VC3c0smn0Pz47zO1QKkignxl4HjXHtxDkQ2dyuYS3fbvGZLM4H9mF/kI/MpAepGvp7pmlLXW+Y1g0h3RiiTJUAAbyjqvMcXp8e59u+QaSR1knUvPBYxTQ/HO446NfUVv9mf5RPadJ2Nwucqyk4aDEY2yJFuw7ZqP27jHmfw0m909FOpuUGGuiEeJUPqgeJXb+wtAuoQRFd1tU+h0UIEEAN5zloUbq7sRlkFyIvk4gsQ9TdYLmqqmpZdSddC2O9Eet3QWGCHYm3Yg0OuV7S3qlohWk2O5Ol4elo19Hvj3b99PpSSRNhfT0qvVWJWJcnLXW9z2ERAgQ6r67zHLTtqTe3EHQXMIo7npEsPJwf3Rp69+EiBQmFiCJIqFyqq3dLtTjR7szOxijqsoh0s4VT0QoGpqOtEgL0+lIP0njyhjvGK9DfqZ3BVudPl6bPYTECBDqr7vMctFDUnbEQTaF6Q88Gmd3D5IyNZS2j7tNttXjWh2aGq8Tt6GzSiV0J7TZsDUZ5yUns8p6Hlp5A3dQp8BdlKz4AhVKdVq6/u9qNoKypnKh3AwOhz6EcAgQ6p6o+hzL0RqbFU4ipTL3j1KVbPVsLmKLPwcDCYxl6Xpp6s9AbteqL9THbBZm0Kkzobuawt5HfEVYvSKsOgWth03QTfQ6LnKXrHcql8ptR/xZB4hoEB/oclkWAQGdU3edQhrZCfz9+mZcyrb2QypzrHaUu3eyZ2ImwtvAoSwsKK/Wt6pG5NRychwk9Nn3oXIqYttH1c8wWbhumdhrOsqkbBFwgZW3KD6n6lGyVG4ZcyBEk3qf3IL0+ux4c6HNYDQECnVBXn0MZWhhq3KC219fmQ4SaOPP5800saAwuPMrSc/F88tLkY9MiXB9FyVsRKPT5NJ2a2V7XIkSPU7sMGqWpz1Z3GXT9BoNuj6F8j+Fyw6Ozk+Bn6BRBoigdVC9S12rcdU31d0UllK3aEVwBfQ6rI0Cg1erucyhLd9ZUcx9qtGu+ADhzsyBRV1lFhH0O87QA/+34IJo3jiJQzNOCWAuhszTNfx7Vi+tzFT+TvncRFrQAKR5PTAsQve622lZGtQaLp8AX9Dt8PJ3kzbxVmC8d1O+FygbbfKK1XrMqn1WpEmcS0ecQAr9FaKUm+xzKKib+hDsfwrnkOHW6YZdt+CBRxTop0j6HebGFh6vMxitePmIx9QcYFsoGC+0iFAd3FYGhLbJ8UXqSL6JCSPQSiHFDIz8F3na5YZ1npqiMRx86vFDlggoT+j2J/e8DoeF96nNQqVLVE/e6gN8otIqFPodlzLbP03zWdrC7oqk/6XkyOx1XjZ75ImedZmuFBpUoqc/B6AnSZbUlPFxHv0/z89u7PMt9nhYPWiyGeL3l09A2ItrNyPxNBuPlhnptamJd3YqegKJvJ7Y+JAWGovdIH10/NXpe0eeg3yvKlcIgQKA1LPU5LEN3urSgVU9E6HrffKGgsxjc7OC5TCFCoaK3uAFUd1bz3QX9b3XydUv+3qpEQf0n6C6VfGkhcWMjwIz7dBaoaysbXFUEp8DPs3II3GV9SPM9SFWVC5ah94pBr3/ee7TR6xMYrqC/+7pxoNc+wiFAIHpW+xyWoTeiX49e5DsRlU2tyd4GChfXQdZr05u86l3Ztoab24UIcjL8JHVZv2/2BRXLKfAF/S1sYvehjMv6kIpSwaIXSZ+LEczrBIwiIIhCgpsrL2Q3sRwmblWLAIFoxdDnsIxixKvudunuKI2eYcymXr2mWQ7v0O9E0HHKOpPF0ks273PI8l2SWMz+Bsa1Q/i2VLDcov6yxWzbeo2aRp9DPfiNRXR8n4PKlf7axmdPd980vvD2aKcVp/U2hdneWESBUrtSQYYYpJnrHU1nZ7I0fbBj5nugIuxVUnlh28tM2D2oDn0O9SJAICp7++OHPjxE1eewLL2JajdCAeL2aDd4b0Tbqa9kPHlDzSsWCjoJLXWud+jPZBk2ECIin472ghOAsQb6HOpHgEAU9vbHnzjnnsTc57AKvaH+cvg8P/BndlooQWIRal6xLIUI3RUONtq1gTNZYj0FvqA7xpSbYBX8zW8OAQKm7e2PP/DBoRV9DqvSm6s+CBKX400E6yhKZ4JMZnIXzmQZVHdKfF6mdBrnKfAFlZFZbZqGXfQ5NI8AAZPa3uewqvkgoTumXa+n1ba1Fh80SGNdWoxoik6wgx2dDxLakTiZncOSFWey9FdME3OT1PLwEHmZt8qWWABiGfQ52EGAgDld6XNYRxEkNLljOz9pdLMzU5sUFhQcZofw8QaCcPQ7pZ2IP4xuhn896cyIk+ztRoQCRc8f8HjJuSxJNgsgTr/jCiItOo9Fr9vnk5fsGGIp9DnYQoCAGV3tc1jHbJLMbJqMGq63BqNgp+xaou3qozw0TNhtQKW0qP3X0fM8RFS6w6dAkfcsdOtcFl1fhQfCP8qiRNUmAgQaR59DGGq4LqaYaOGjIKHPsc4X15uFfh6NtOWOE+qkxa1Oh+dMlrC0CGSsMsqiz8E2AgQaQ59DdbT4Lu7WaPGjk0yLMGGxb6I4zfUkPX3nsQNNKs5kUV9E1/uN1qHXs/oduBGAMuhziAMBArXxJ0ff9t/v/3DO/Z/OuU2egWrpD/D87oQoSOhj0Ovl4aLOk1C1mMicDwzTM3eaTllYwCz9bmo3gjNZlqc7yGPOd8AS6HOIBwECwfhSJH184oNCERg+4irbosX7Zb0E/aSfhwp34cRUhYukZJW2Fg3FH/9iZ8H54ADEav5MllvDHcqaFtDrXuVKjGdFWfQ5xIcAgZX4sPCJDwn36F9oBy38p9PZ4p8/5MD7OJPlakXN+vF0QukJSqHPIV4ECJTi+xXu+9DwCZOSAHQZZ7K8pZsNxWhloAz6HOJHgMCV/C6DQsMDypAA4H1FkFD53+7GZj5KuQu7EsVo5denx9SrYyn0ObQDAQLvmNtpeEhoAIBytBjSeSz6KMYoty1MKDRot0HBgcZoLIs+h3YhQCDnD3HTTsMXXBEAWF0xilhhQgMItgbD81HKsdHPofHKGmfLIY5YBX0O7USA6Li9/XGx20ATNDBHd5RVlgKsI594dvJ24a0QUZzJUoxQtoLzWBASfQ7tRoDoKB8cHtMMDVxOi6ftAQECYV1cmBdnsChUaFTy7HyWfqWlT7ojfJafvzIbuazHc5am1KQjGJW4jSdv+J1qMQJEx/hSpUfsOACL6YA7oGq6M3vV3f75c1nm//nif0dhY/78lXnzwYCQgKppB0ule+xetR8BoiN8c/RjehyAcqj3RtPmz2VxjgUZ7FIQVnCgz6E7CBAd4MuVnjjnbnX9WgAAgHCKU8fpc+gWAkSL+V0HBYfPa/0pE+eyXqK9df/P/j/vzf79PVl++2L2P9XNNv0RSvXPJf8Y9RKXqVQ98Z8Lff/N9LX9l0rS2b/n3yfljx2uxhY8AFyNPoduI0C01N7++J5z7utamqQVErRYHySzz8sOFUneLvZnAcD/s5tb7E8zl5y9XfDn32ej5Pfrvf0vFF8/898gDyln735tAABwOfoc4AgQ7bS3P37g+x0qLVnKBj40DCocQ6jdBe1gKCz4Bf9KIeUyydzPoK99mrnkJA3/MyBKMc7sB9omc9zcsYI+B8wjQLSMDw//qPKnyrSYH/bCLOKXUSz4q/raw8RlG32XHKfly6dKsDTnHd2U9Rf/DiZzZX5rU+i/8O0SX5YILEunXt8a7nDdGkafAy4iQLRI1eFBi5Bss4HgUCcFia2ec5M035EIQXPdEZ/onrf53qOe7z3qlXuxnv+m+yBR9AjlQfqql0FRutj3u4QLQko29w/515zSh4RyivG0HOrYDPoccBVWNi1RaXjQQmHUq7ZUyRj9vK6XuWQS5rapymGoF43LRi+CBUvPB/tBsnABX/7rvduLdN6HdOZmfUJptl7p4nzZoPOBQqWDZyk7FLiSzq/o9wkQdaLPAdchQLSAPxyumvDQS1y6mZS+k9kmKtVyaRJkJ2LYI0DExnIPRF5GGCo0XEclScNZiV++6g/5LYvSwWE/Dyh5YGdTAhfobyc9SfWgzwFlESAit7c//sBPWwpP4WGr5SVL11CvR3I2XXtRszUY5jWkiIPKlyyWTDTWf1So8Ptm+RS3fh4imIoG1I8+ByyDABG/ag6I0833joeHnO6QbvTWns6kBak+ON04Drsbm6YeZ16mNOrATqBeb+qzOg1XPghgMfocsAoCRMT29scPnXMfV/ETpG1vll6C6sFDXAotSl9MXtf2uLEaTc3aHtgJENpxyMuHOiQvH8zWD+4X9ZPecv8DoMXoc8A6CBCR8qdMP6ri0edv3nXUVsci0LXQovTlyWE+VQR23djYtvHYOji8YF4emqZJ0JHKTPIB6HNAGNyOidfDqg6Ky2us8VbAUZN3Rje4sIbpDvXuxpaJB6gSwq6Gh0JezoTO4yydcNTn8K+j54QHrI0diAj53YeHlTzyXqBTnlskCVgWqkkim/1hXnMKe6wEvHzh3MHJZ+/xY19DNVXr9feKao3ocJbO+uhzQGjc3onTg8p2H9jhf5fm1Aeuw9YilVpse7TzYGFUZLbqGQttFTBIsRCNEyNcV6c+h9+OD9zvxy8JDwiKVUycHlT2qNkqfkcVc+m1Hf/HzZtsyxuiBcqt4Y6JB5QfYohK6DVHiIiLdmyxPPU5aGjHr0djmqRRCd6pIuPLlz7q+nWonHYejqqbR69FjJUFa9fpufjD6KaJq5DvPJAr3xV4Jv32YBT066FaOkMHy6HPAXXgVkx87lX6iLPQR83Gp64TcYtRoYx2bc5sN+iGnd0gSpfelbngIV6vOy2wOCzLPr0uN/sEvrLoc0CdCBAR2dsff+Kc+3+qfMTJ+ocuxytVcMiCjo28DiGiOdp5uDPaNTXaMyM/vCM5zSopIVRZzOHZJOwXRnD6+0ip5/U4zwFNIEBEYG9//IFz7rFz7vPKH23q37C79DfbN0rni5UGFCFCbwDcFa2HwsOfNm+xODEs3wkMPMCgcHO4nd+t5fVml16bZs5kMYrzHNAkAoRhc+Nav6zzUeoOfFemwCQnmUtOqy9Xuo5ChBa1s0kZHDRXJd191iQswoNdKiGsMtBr12lnsJWXMsEmPT+8Rq/2+vSIUjw0igBh1N7++IHfdahkXOtVNH++C+Hh/O5mTWt1bTFfN/1F//c/b91xzycv2YquiBrXrRwUd5kkfMVOXKaZ603qeV0WuxB6bcIW/S3U84P36b1BJa/0OaBpBAhjfJ/D4yYmLXUiPKhc6Tittc/B+a3mMnTHTaU13F0Kq+h3MD/CU7+XXWykbuh1qd8JzcjndWaH/gbqecG7tDP9YvKKm0swgwBhRK19DpfINlp+eFXDfQ7L0l1yjS/UnSbeMNajOupY7mbm5YMGHkdtGn5dFuOUGWJgh54Pzup4S+FWN5N0UwmwhFdpw5rqc3hH4lw2bO+RIFqc5OVKDa7MVulrUJ22diNmo/le0xuxJB0OZ23K0nUy1Xx3ZIiBhdel8/1HRTMqmqXwUAyVAH0OsI0A0aCm+hwuau3hVXk9dTabLNWwdI3Fv5p+/237D+7lyaF7c3bEm8k1FBy066DPMcl3AbtwCnUDr8vrepC046f/DqNdm6MD/iz3J9WJPgfEgADRAN/n8Mg597GFx9O60qXMT3Gp6BTpZWnnIMSiX2U4eoPVXSmN7WNH4l2xBgfJ+h0ID8ZelxfNJnP1KBVpgMKDrn/X0eeAmBAgauT7HBQcvljnu56kp27YC7hI6rUkQGRzZRGGHAW8q6kGQwUJfShEvD497vwUGS0+VPYQY3DIJbMBBq1l4HVZNsDP6u/79ETUSGWGXS9bos8BMSJA1GCuz+FhiHKlk+lZ2ADRAvlY1knz9dSXUVmEypBC05uuPhQg9MbTpYOx+knvvNE8ph6Hy2Qbvdb2PNQ9Lvkyy74m9JrS75TGKVMuWJ3ZtKUblfxtjAl9DogVAaJivs9Buw5/CfWdtFDcGozyRVQQqkXuR7qCmWazw+BqHv9Ylhb3+qjyTXI2onS2/a/fDe14tDFM6Pd9K99tGLVqSot6H1rH0OtSO7bJkglNu1l/3rrtfj9+1fkdviro9fvHzRvRh/910OeA2BEgKlJ1n4MaakPNytZdwiy2ABHJWFaVGNVJQaUIKwoRepNSoIi1X0ILOe22aaehlaMdey2buGTwdanXwCoBXotbhQj9reXE6nBiGqtcBfoc0BYEiMBC9TlcR/Xv+iMcYhcinz0fy+jIop761Ga50jy9Qeh5akoRJlTXrbtcejz6OE2nZu+qFoFh2B/kn1XmYI0WAKF2/zKDP9+q8h0Hg6/Lo7OTtXYA9XdWAVZjXln0rU6v7S6f8UCfA9qGABFI6D6HMnQXQ+cErC2dLcqzoe3FjIV66mVYmiuvu6nbg/47zYqzMHGWL4j1+Syd1rZToUWEwoFCwqDXy/89loWFQqHuomLG8utSv+MhSkT0u6m/tXrutSPBBLTyFLYVwrrcKE2fA9qIABFAFX0OZejNUX+YQszOzhcAvZ7Nka6pGqTt9jlcRm8W1mundUfwsslFetx6o9PC6yydLZR0PvKyP898o3/xfRQWYq97fnM6CRYgoj55OoLXZehzHbQI3uyP8r+7nMmymG4Q7Ay28vcnizuJdaDPAW1GgFiDhfMctFDV4izE3dvkOHVu01CIiKTP4SIttHWXMlZvf5eY9HUZLQa0MFUzdwh5D1JMZ7FE8rqcHQwXvoSwGKXMmSyXIzjQ54BuIECsoK4+hzJ0B0yTQtTsF+KPdR4ihr3Gy5ms1lNfR8/Hb8cHth8k1nZw8jqvqw+yQNJCPJIAcX6eQwSvy6pLCDmT5V268bC7sdnpUiX6HLCGcWwXjwCxhCb6HMrQHVEtWlWjGyRE6O7iWeLSUVL/eNdp5nqTePoc5hXhgbKG9isWCmoKXVdeAqQeJMvjXCN7XRYTyOoyfyaLdqcUKLrwd0DvNwrS2m3oanN0gT4HrOmb2C4gAaKkpvocytIbV8gQofrm3tFsvGu+G1F1kMhmux8x9TnMK8IDM+O7QwsGlQ+GOOMjPwQxMdiDFOHrsigfaYIW0beGgzxYtvVMliI06EyWrh8C5+hzQCA/f/bh97FdSwLENSz0OZQVPET4u6PJUZbPq9eJufkCJ+AaR/XfTlNczuJ9gyU8dJcWqn/euhNmnLKlHqRI+4/k92MbJ0jPn8mivw0aJ6swEePfCQWjIixfNnihi+hzQNcRIK5gqc9hGUWI0CFzQbeU09ld0mQyO/wqP3hOuxO9/JZUua+R+cktU/854tBQ0PVWDwp3n7pp1oP0Mlz5oELEhnb9eo2dy5KPZZ3E13/k8kD32uQCPR9TPBy4m247/53R6dgn07P8czH1zJIYzmNpCn0OqMC3MV5UAsQFVvsclvE2RNyoZotZYSKd1W2fv630EpcteI+JtTRpEdU6q5mWmtduC73zlzcqT6d5iKh1NyLvc8jycB8jhYcmD24sqygBmv/brBsQOuBRoUL/XJzNUvXfFgWFxCV5wFFY2Oj1ox+zXCX6HFCR6MqXHAHiXdb7HJZR3BlVc5tm1ld+BynNojjIOgRdW014iWGxgnqE70HyvQcVlQ6++72y2dSziHcEYwkPV9Givd/vX3rDZz5IXCyXuep8FpXUXQwCRemRfj+73vC8LPocULHoGqgdAWImpj6HZemOif74qamP2tX18UaCq1TRgzRfOpiHiEEyKx9c98tnvlTpNN4dh0Ls4eE684t9/obXiz4H1IQAEZtY+xyWVSxsatuNaCF2HVCGXmu/Ho3dHzdvBL/Lez5wwM31ISUKFL4P6bKXddF3lM3CSP7PCgwtOPdMr8nnk5cs7hCcfrd00njMB4IiGl/9/NmH0Z0B4boaINrQ57CK4tRUhQiFCZRTNMxR94oyinNZbg13g51W/Z6iD8l1p3RwHsMLUBV621CzJ7Fe8M4FiDb1OayiuJOuU1N1gmplC5wW0BuJ7kCxSMGy9DpT6YPOAdAwA3b9wlGg584wQtNOlt4bGceNGn3782cfRlm+5LoUINrc57AKLYq1wNEb8e7G7BRVFjlvt67fnE4IDlib5v7/6+h5dRPROkQLO6tjWhEv9TmMJ6/z1ypQs0cxX/DWB4iu9DmsSotk3XXRXb3N/igPE12c0KFFiXZljqcTtq4RVDERTQ2wChIhDp3rEubuowr0OaBh/4x598G1PUDs7Y8fda3PYVX6Y6r+CH0oQKi0aWswavViR3eeVGKiUiXuaqJqKpH45fB5vtun8kGCxPWYu48q0OeAhh045x7E/iS0MkD4cqUnXe1zWJcW0wcnZ/nORNvCBKEBTSuCOkHiclrUqZyE/iOERp8DjHgQ6+Slea0LEHv748fOub8aeCitMB8mdDDR1mCYl2IMextR9ExoMXKSnuZvHEdnJyxIYMZ8kOhq6eA8hXtdDyaeITT6HGDI337+7MOv2/CEtOYda29/fM/vOnxk4OG0khbfenMvapEVKBQmNnr9fPGjjyZDhRYdCjyzj2keGggMsG6+dFDjldVs3aWBBlrUKdxzxgpCo88BxujMh6gbp+e1IkDs7Y/v+/BAr0ONtDg/PHt3ga6Fz3yY0OfEJW7Q6wcp1dCdpLN06jI3CwvzoYG7lojZbMrQq/wn0K6EdvvaOrlJP6vKCNkVRFXoc4AxCg/R9z3Miz5A+HMd/mHgocDf8dGd/+tOh9XORVmcNIuuKXYlFMJVLqgeJL1mYu6X0E4DpYSoGn0OMKh14cHFHiAID/EiFADXKxqKi9pt7egpSMxKBwdmA0WxM1j0H/F6R9Xoc4BRrQwPLuYAQXgA0DVFuV7Rh1SUCc4HirqbsYuyQoWFszQ9f4xAHehzgGH/+efPPnzS1icoygBBeACAq0sGNeBg0Ovl/UfD/uzPfNGPVLhu6MHFr6mA4OZ2F4rPQFPoc4BRPznn7v/82Yfft/kJii5A+GlLjw08FAAwST0G0+msz4CSDrQNfQ4w7O/OuUdtOOfhOlEFiL398W3n3NdMW0JsaBoFgPXQ5wDDfvIHxH3TlScpth2IR5wujRjxhgcAq6HPAYYd+B2HzlXGRBMg9vbHn3DCNGJV1It3/bRhAFgGfQ4wrDPlSpeJaTXTmtP70E3afi9/+gUAdBd9DjDsW+fcw7Y3SV8nigDhdx8+NvBQIoVjnwAAIABJREFUgJWdTM9ae7IwYNmsB4n4HgP6HGDYTz44qBe382LZgWD3AQCwEp1+vT3Y5OIZRp8DDFOfw+OfP/uQtegc8wFib3/8AbsPAIBVUQZjG30OMOwrv+vQyT6HRWLYgbhv4DGYMn8YFABgMZXFwB76HGAYfQ7XIEBESJN8qA8FgPKYgmYHfQ4wjD6HkmL4a0r50gW9hB2IGA37kS5eEueyXuJcT/88+5wt+BVMVIVQ3PCdZi5RWcIyN4B7xfdL/Pe+5HsU5/Kt8vXRSZTHNK/oc3h9esTzAWvoc1iS6RXN3v74noGHYQ530eK00evH8bi1aB8kzvUTl/Vni/hlZBe+WP7veajI8oV/cpbl/zwv/36D8t8vO7+Ub79+Ms2cO8tmXx+AKepzUIM0p/LDIPocVmB9JXrbwGMwZ9RnHGFs+knP9RPDAWI+NAwq2OFKnA8kzmXDZLbg10Jf/39j+ZBy2dc/DyH62ifp+dcH0Bz1Obw6Pcw/A8bQ57AG6wHiEwOPwSSdJ0D9aDzMhj6VC230ZovvOivjEh8cqvrao57Lhs4lkzT4joR2AGn6jA87t/VSn4N2HA7Pjrv0YyMO9DkEwF/USG0NCBAxMTeDPvHBIcTdf6v0M272nDvN8iARCj1I8dFzxvNWD/ocYBh9DgERICKlBemsnpTuUetUvmRpB0J9BvnCuiPrqVlI6rnkOMxrZdjboBwjMuw+1IM+BxhGn0Ng/FWN2M3htnsxed31y2CenicrsmFv1oPQMXmJ1qgXZCdCu3+q6UY8VPKJ6tDnAMPoc6iI6QAxzdJfdfcWl2MXwj7d+bRSvqRdh0oapCOR70ScJbNpTWvQc6q/S7zu4qHQh/Doc4Bh9DlUzHSAODqbDHc3tgw8Ertuj3bd78cvu34ZzLo13DHx0PKm4g6Hh4J2X5Kj9euyFQrZhYjDLPBFMkI5EvQ5wDD6HGpi+vb+0dnkmYGHYZq25rcHo65fBpMUfi30Pig4VDbxKDb9JMhfvZ0NXnOx2N0wNsAgcupz+PVonO88EB5gjPocPiA81MP0DsRJevZaW6SUMS12a7jrTtMpoyUN0V1PE7sPfqQp3sqSpDh+bmW6o63grsUU7NJ7h7kJaJGizwGG0efQAPNN1PpjxR32xTSe8M5o1/12fMAdIQP0fPxx84aJx1L7+Q4RSAK9RBTcNUqZ15xdd0Y2Xocxo88BhtHn0CDzAeLobEKAKEF3vP+0eYsQ0TCFBz0PVmquKV26IMsLuIN8KT3XNza23cHJm4APEKGovJNT+1dHnwMMo8/BAPMB4iQ9zf94cQjQ9QgRzSrCg6mZ8z1eN/OS07CvC/W5aBeCsg5bZruy7D6sivMcYBjnORhhPkBoIaw3aHYhyiFENMNieNCBcZgzzVxyEn706h9GN92vRy8Y62qInhNuOi2PPgcYRp+DMVEcJKctVAJEeUWI0HhXFjXV0/VWDwqn3dqVnGVBDpG7zKzn5Sah3Qi9FildWg59DjCMPgejoljxaLqQ7ojwplCeFrN/3rrjnk9ecjepQqqzVqmExbudSZatOWuoBTKX7zqELl26iJ0/GzT5jKlL5dHnAMPoczAumvmOHNq0vKKsxsphZm2j66o7z2ZLJVLfNNxRCg29w2nl4aFQhAhKZ5qhhnYOHi2P8xxgmPoc7hEebIum5kJ30Q+ZyLSS4kCzF5PXnBURQEwlS8k0694J1NPM9SZZsGlLy2Anohl6PbLzUA59DjBMfQ6Pfv7sw294kuyLqmj74OR1XjLCHb7lzUqabudb1XrzYHGzvGJsZ0x3OZOTDgUIlStN0rzfoUnFa+3341cE9ooV05b0voDF6HOAYT/54PCEJykeUQUILXo1c113m7AaLX51p05hjFN0y9N1U3iIKrz2EpdudeAU6mxWrlTFhKXLlBkrrXNAtBPB66w6DC8ohz4HGJb3OfheB8ayRia6v7y6e7I1GHLHaQ3FXbubw21/R4oFzlVUMqfrZOVguNKK8NDyzYfz6Uo1ros0G7+XXP+ns3idbQ1G7sXkFYu3gKIM9A3gPAcY9pXfdfiRJylOUd660ZuxuQO7IqRF8XyQ0HkbLHJmCz8F1CiDgySu/eEhP9Mhy3s8rNPvkkqaxpM3+WsMq+snvfxvFhP5FlPpnHbr6XOAQfQ5tESUK3AtctUQzMSTMIogoeuqHR5tdXfx/AgtTooSr5h/r7JRi8NDTWNZFz+E5b+3XmOa2KUAMZ685nyWJen1uDPYykM9rlaU+dLnAIPoc2iZaG/h6w6LzjhQiEAYepPWAlofur4KEm3flSh2G/Qzt2JHK3GtbZrOdxxO6y1XusxZmrrhiq0l+l37t+0/MMxgCdGWEdZMv0/0OcAg+hxaKuoVk7ZntRNBU3V4swbFG/nXVYg4Opvk17sNd06106ASCNWmN91Lk2ap6yXhGp3bGB7yPgc1SBv51ZtNVlpvnHSx06UFnxpcWfS9j+BQzmxX6w19DrCIPocWi/6Wa7FVS4iojhbZxUK7OBVcHyfpaRQLH+0yDHsbeWjQh6WdhtlEn4BfsE0lfakapG31Oej5CjWaVb+XWiDrQ3/HZs2u3S5tKkqVdjZGBIdr0OcAw+hz6IBWdCETIuqjxbc+irMQ9CY2+5ieh4umFSFho9c/f7xWacE4cCyU3mGgz+EqVTVBazdCH7MDM487NxlNr1ntOHAY3PXoc4Bh9Dl0SGvGGOmPqcpBVHZDY3V9LlugaytddeJFmNBOhfNhI8SOhZ7f4ntqZ8H5Bcig14vyriUnrL91fp6D0Y0tlRxV+fel2CW7Ndx1x9OJOzo7ae3kJr2G9XuvsdzsNpRDnwOMos+hg1o1B1VvtL8dHzCdqWFaDPT7/YWjFpcNE/OhoW1UuhIqQKhfIBtG+Ls/zVxvYqfP4TIKxPq9rWOEqH7fi10JvU4UJvT9Yx9qoGunckhCw3Loc4Bh9Dl0VOtWZHqD/9fRc86JMI7n5i0tCoLtQqTZ7CNoY0WFVK50nEZxnoPu/jZhPky4yPqQFBi0SzjsDzj8cwX0OcAw+hw6rpWrOL2h/no0dreGO+e1+oBl2oXQAivEzpkaj7Mt4wHCcJ/DZQ79FDILLvYhKYCqB+lkenYeKEI1epdV7BDG0ntkHX0OMIw+B+Ra/Re+uHNDXwSs0yJQd7gVeteV380/sVvKlI9lndjtc7hotph7betBzSlKBi/e4S/KBIvP+n/zweIsnV479eli6aBGIBelR0UpF6dCh0WfA4yizwHvaP0tItWOqqTpD6ObvNHBNC0aihrxdeWNyL2erXMh8j4HX2IVER1YGeNirlj483cvDvQ5wDD6HPCeTuwx681fzdWqIdYdXnYjYNWLyatg/TvqLXAbictG4Q6qW4nKlSZpvvMQG+rPUTX6HGAYfQ64UqeKVFVPqmkmGpHI2ExYVITdP2/dyctF1pWPRZ2mLh0lqj+p9yfO5sayRkh9D9oVAqpAnwMMo88B1+pcl5v+aOsur/5o39jYZnsf5uh39Pfjl+HGEaeZ6x1lLusns76IGoJE3udwYnss6yIKD/o7AVSBPgcYRZ8DSuvsmIzZGMRZWdPN4XaQu71AKCpr0E6ETlcPNc1GzdXJ0WzEa6bSJvVHhMwSmf8eEQcHR3hAhehzgGH0OWApnZ+zV5Q1aSSidiQAK4oQEfxMkzTLR70mEzcLE4PEZf3ZPy8dKBQYpsXn+O+mqqSEsiWERp8DDKPPASvpfIBwvmREc/jfnE7c7dEOBx7BjOJME40irqRvR2HiJHubG3rOZSqb0obcZeVTKrlInUv857YoSht1hxgI9/KizwFmqVzpIX0OWBUBYo62lVV7rr4ITWviICRYocWt7l5WPkVM4UC1SHmFRTfqs3V3+PfjV5SVICj6HGDY3+hzwLpYIV9CCzXd9WXsKyzRXczZwYi7NP8HokWedh+BUOhzgGH/9LsO9DlgbQSIBYr+CPVGqEcCaJoWJZxpsj4FsReT1yzyEAx9DjDsBx8c6HNAMASIaxQ1rK9Pj7nzCzNo/l/NNEvdePKaXgcEQ58DDKPPAZUhQJRU3PlVgFBDK2Nf0bT55n+NIuZwxKspOOhaschDSPQ5wDD6HFApAsSStD39y+Hz8zu/lJCgaQq3arLWAnl3YzMvb+L3cobggCpQAgfD6HNALQgQK9JdJy1Kbg13ufMLE7SYUSmF7ooqRCjkdnWnTCVKb06PKVVCUAqkxUQ0wBj6HFArAsQaitnxChNqaKU/Ahbo91K/k/rQ76TChM42afuuhBZ3+pmPzk64M4yg9JoqypUAY+hzQCMIEAEUJwZrkXZ7tEt/BMzQndLibql+P7cGo1aFCb329PMdnk3yfwZCU2hQeKDPAQbR54DGECACUrmE+iPU0Loz2KIOHabo97Mo6dEhiVuDoRv2NqLaOdMi7iQ9zXcZFBzYaUBV6HOAYfQ5oHEEiAowGQfW6W796cnbO/YKEQoVxWcru2haxOWPNZ0SGFAL+hxgGH0OMIMAUZFiMo4arTWtif4IWFaUOs3XeOt3tp/03aDXy0NF4pL8c+idNQUE7Sxo4abXzcn0LP9nSpJQJ/ocYBh9DjCHAFGx2cKMk4MRn9kd2Kvvwl4MxYtC8lmavrN7oMUaAQFW0OcAw+hzgEkEiJpwcjDa5mKJByUfiA19DjCMPgeYRoCo0fzJwbdHO/k0HABAvehzgGH0OSAKBIgG6G7X78cv85IPlTWprhwAUC36HGAYfQ6ICivXBunu169H4/OyJvojAKAa9DnAMPocEB0ChAF6YyumNSlMALDrLKVePib0OcAw+hwQLQKEEbordnDyxr0+PXZ3RruMfQWMKkbMUnpoG30OMIw+B0SPd0BjdJfst+ODPEDcGd0wc6AXgLe0KCVA2ESfAwyjzwGtwTugUVqg/HL4PD/NemewRX8EYAhnWNhEnwMMo88BrUKAME5jX/WmeGu467YHo65fDsAElcfADvocYBh9DmglAkQEdDdNtbyzILFDfwTQMO5w20CfAwz7yTn3gD4HtBUBIiIqm1B/xPZgMy9toj8CaAYlTM2izwGGqc/h0c+fffiYJwltRoCIkEa+Hk8n+chX+iOA+hHem0OfAwz7uw8P9Dmg9QgQkdKbp/oj3pxO8t0I+iOA+gx6fa52zehzgGHf+nIl+hzQGQSIyOnNVDXA2pVQfwSjJeMy6HEnG1iEPgcYRp8DOovVZkvozfXXo3HeH6EgQVlTHPpJP3+uKMeIy7DHIIOq0ecAw+hzQOcRIFpmvj/ixsZ21y9HFLQYPZ6edP0yRIVJaNU6PJu4g5PXBGtYRJ8DOs8RINppvj/i9mjHbfaHXb8kpm0NhgSIiGjHiABRDe2kHpy8YcoVLKLPAZhDgGgx9Uf8fvwyX+zcGd1gcoxRm301wL/u+mWIBoE8PPU5jCevCdKwiD4H4BIEiA7QXb1fDp+flzXRH2GLng9N0VLZBuxTnxHC0G7pm7OjfMcUMIY+B2ABAkSHqBlRPRIKEQoTsEPPBwHCPu3mUb4UBn0OMIw+B+AaBIiO0Zu1aoxfnx67O6NdFkNGaPwuuxD2MZhgffQ5wDD6HICSCBAdpf6I344P8nru26Nd+iMM0IGAqgHnjqxNeq0QuFdHnwMMo88BWBIBouP0Zq7+CC1edwZb9Ec0SGdC6A637s7CFr0uNIgAy6PPAYbR5wCsiACBnN7c1SNxa7ibl9KgGeqFUIkHd2ltUXggXC+PPgcYRp8DsAYCBM7pTf7F5NV5ozXlGs3QYlXlZdSI26DXAqNbl0OfAwyjzwEIgACB9+jNfzI9yMdVqrSJ/oh66U73nzZvuX8dPefObcO0G6fXAMqhzwGG0ecABESAwJW0E3E8neRlNfRH1KsIEdqJIEQ0Q+GBvody6HOAYfQ5ABXg1jIW0sJAi4Jfj8bcVayZRrsqRLADVD/CQ3nqc9BuGeEBBqnP4QPCAxAeOxAoRWNffz9+mfdF3Bru5ItbVE/X+c9bd+iJqJF6Hihbuh59DjCMPgegYqwCsRQtGrQbof4IBQnKmqpXlDNpmg0HzVVH11m/0/rdxtXoc4Bh9DkANSFAYCXz/RGczlu94hwC7QDpri99EWFpp0cns7OzdjX6HGAYfQ5AzXi3xMqK/og3p5N88cXY1+rp7riu84vJ63w3COujZOl6nOcAwzjPAWgAAQJrU3+EavS1sNVdcpp+q6UTq1XSpIP/Xp0esqhbEf0816PPAYapz+Hhz599+D1PElA/3jkRjBYbvxw+Py9roj+iWrrO2pFQiFCYQDkKuNpxoNfhavQ5wLCffHD4micJaA4BAsFpMVucZq1FLqpTNP7ubmzm5WQ0WV9N10rnmeh3knB7OfocYJj6HB7//NmHj3iSgOYRIFAJLURU+qAFrRa49EdUS2VNKh/TnXWCxLu041Ds1hAcrkafAwz7yu860OcAGEGAQKVUO63+iM3+0N0e7dIfUbEiSNwa7p7vBKkcpYsUWnUgHKVKi9HnAMPocwCMIkCgFqqlVn+E7pCrjIQ7wdXS9dW11oeu/dHZJP/c9rvLCqhbg1Fe0qUwhavR5wDD6HMAjCNAoFbF2NdZE+uIi18D7f7ow/kg17YwUYQG/T4xUel6RZ+DdqgoV4Ix9DkAkeDdFrXT2NcXk1fnjdb0R9RnPkyodEUfChMxla9od2XY28h/b7YGQ3YalqA+B4V4vQYBY+hzACJCgEBjZgvYg7xGXTsS9EfUSwtwfdx0s0PUikChMKEPK70T2lXY6PXzz3q87DIsT8+rxv1y+CAMos8BiJD1d+J7Bh4DKqadiOPp5Pz8CDSjCBQFlbcUYUL/fJLOFp9VLEK1q6BgkLjZ50Gvl+8ssDu1HoXA2VSu45h/DLQTfQ5AxKwHiE8MPAbUQAvUoj/i9mjnvMwGzdGi/mKomKcymLP07S5FETQWKYJBQWGBhvrw6HOAYfQ5AC1AgIApWpT+fvwyX7Tq/AjKVexSEOj334YBdgtsoM8BhtHnALREkhm9O3X36TOVL/27gYeCBqk/QkGCu9TAYvQ5wDD6HICWsXx797aBx4CGFf0R6o1QjwSAd9HnAMPocwBaynKAoHwJOdVw66Tc16fH7s5ol1IZgD4H2EafA9ByFJgjGqrp/u34IA8Qd0Y3GPuKzqLPAYbR5wB0AAEC0VGN9y+Hz8/HvtIfga6gzwGG0ecAdAgBAtFS6Ybqvm8Nd932YMQTidaizwGG0ecAdJDlAMH2J66l2u8Xk1d5mNC0Jvoj0Cb0OcAw+hyADrMcINgGRWk6xEz9ETqA7vZol/4IRI8+BxhGnwPQcZYDxI8GHgMiczw9cb8evcj7I3YGW/RHIDr0OcAw+hwA5MweJOdmh8np7sYtAw8FEdJJyTeH2/RHIAr0OcAw+hwAvMN6E/U3zrnPDTwOREilH+qP0IJM05roj4BF9DnAMPocAFzKeqE4dzuwNpWCqD/ixeQ1CzSYoj6HX4/G+c4Dv5swRn0O9wgPAC4Tww4EEIR2Io6nk/PzI4Cm0OcAw9Tn8Ojnzz7k/RfAlUz3QLhZH8TXlDEhNPVH3B7t5FObgLrQ5wDDfvLB4QlPEoDrxDDrkj9mCE79Eb8fv8xLmzQCFqiSypO046AJYYQHGKM+h7/5ciXebwGUYn4Hws12ITTS9S8GHgpaqihrYuwrQuM8Bxj2ld91YGw6gKVY74EoqInrHzYeCtpIE3CKaU0KE8C6tLN1cPKGPgdYRJ8DgLVEsQPhZrsQ+kP3sYGHgpZTf8Sd0S5jX7ESlSspOFCqBIPocwAQRCw7EPLQOffvBh4HWk6lJuqNUIP17dGu6ycxtArBAvU5cJ4DDMrPc/BnOox5ggCsK5odCDfbhVAp05cGHgo6RKdZ7wy26I/AlY6nJ248eUOfAyyizwFAcFEFCDcLEd875z4y8FDQIQoPt4a7bnsw4mnHOfocYBh9DgAqE1MJU+GBP2Dulo2Hgy5QScqLyau8POXWcIf+iI6jzwGG0ecAoHLR7UC42S7EfefcfzXwUNBR24PNvLSJ/ojuoc8BRtHnAKA2UQYINwsRDxjtiiaprEkjX+mP6Ab6HGAYfQ4AahVtgHCzEKEt2i8MPBR0mMa+ajeC/oh2os8BhtHnAKARUQcIR4iAIeqLUH/ERi/G1iJcRJ8DDKPPAUCjog8QjhABY9QfoSBBWVO86HOAUfQ5ADChFQHCcUYEjCn6I25sbPPURIQ+BxhGnwMAM1oTIByN1TBI/RG3Rzv5qdawiz4HGEafAwBzWhUg3CxE3OOcCFij/og7oxuMfTWGPgcYRp8DALNaFyDcLER84Jz7mhOrYQ39EXbQ5wCj6HMAYF4rA0Th7tNn+iP8VxuPBpjh/Ihm0ecAw+hzABCFVgcINwsRnzjntAX8FwMPBzhHkKgXfQ4wjD4HAFFpfYBwsxBxW3+c2Y2ARQoPm/1RfhgdPRLh0ecAw+hzABClTgSIgt+NeExvBKzStKadjU2mNgWg4PDm7Ig+B1j1N/ocAMSqUwGicPfps4d+R4JJTTBJ4193NkZ50zW7EsshOMC4fzrnHtLnACBmnQwQjrImREQjYBUktCtBr8TVplmahwaVKhEcYNAPPjjQ5wAgep0NEAU/8lX1px/beETA1RQitgYjwsScw7NJHhpojoZRBz440OcAoDU6HyAKTGtCbDZ6A7c9GOU7FPrnLtEo1qOzE3c8nbDbAMvocwDQSgSIC+4+faaypof0RyAm2o0Y9jbyMNHGQKHyJO0wHJ1N3El6SmiAdfQ5AGg1AsQlfH+EpjV9Ye7BASUoUChEFGFCHzE1Y+vMhtN0mocGfXDoGyJBnwOATiBALHD36bN7PkjQH4HoFaGiCBP6POj1Gw0W2kmYhYWzfJdBn+llQITocwDQKQSIEu4+fXbfBwn6I9BKGhs76PVc4hI37M/Kn/SfzYeLZcKGwsBZ+nbXQMEgc9l5YBCCAlqCPgcAnUOAKMmXNT2kPwIAQJ8DgC4jQCzJj319RH8EAHQSfQ4AOo8AsSI/9lVlTR9F+QMAAJZBnwMAeASINd19+uyBDxKUNQFAO9HnAABzCBABzPVHfBn9DwMAKNDnAACXIEAE5PsjtBvxeWt+KADoHvocAGABAkQFfH/EE8a+AkBU6HMAgBIIEBW6+/TZQz+xif4IALCNPgcAKIkAUTHfH6EQ8ddW/6AAECf6HABgSQSImvj+CG2Lf9yJHxgAbKPPAQBWRICo2d2nz+77Rmv6IwCgfvQ5AMCaCBANufv02SM/+pX+CACoB30OABAAAaJBvj9CuxFfdPYiAED16HMAgIAIEAbcffrsng8S9EcAQDj0OQBABQgQhtx9+uyBn9hEfwQArE59Do9+/uzDx1xDAAiPAGGML2t6SH8EAKzk7z480OcAABUhQBjlx77q7tnnXb8WAFDCt865B/Q5AED1CBDG3X367BMfJD7q+rUAgEv85IMDfQ4AUBMCRCR8f8RjypoAIEefAwA0pMeFj4M/9OgDP8ccALpMfQ4fEB4AoBnsQETI90c8YewrgI6hzwEADCBARMz3Rzxh7CuAlqPPAQAMIUC0wN2nzx768yPojwDQJvQ5AIBB9EC0gH9z/cDXBQNAG9DnAABGsQPRMnefPrvnpzXRHwEgRvQ5AIBxBIiWuvv02X0fJOiPABAD+hwAIBIEiJa7+/SZeiMe0h8BwCj6HAAgMgSIDrj79NltvxvxRdevBQBT/u7Dw5inBQDiQYDoED/29RH9EQAaRp8DAESMANFBd58+e+CDBP0RAOpEnwMAtAABoqN8WZN6I77s+rUAUDn6HACgRQgQHXf36bMPfH/E512/FgAqQZ8DALQMAQI53x+hIPERVwRAAPQ5AEBLESDwDt8f8ZixrwBWRJ8DALQcAQLv8f0RarL+K1cHQEn0OQBARxAgcCXfH/GEsa8ArkGfAwB0CAEC1/L9EU8Y+wrgAvocAKCDCBAo7e7TZw99aRP9EUC3qc/h4c+fffh11y8EAHQRAQJL8f0RqnH+gisHdI76HB7//NmHj3jqAaC7CBBYyd2nz+75IEF/BNANX/ldB/ocAKDjCBBYy92nz+77IEF/BNBO3/rg8D3PLwDAESAQyt2nz1TS8JD+CKA16HMAAFyKAIFg/NjXR/RHAFGjzwEAsBABAsH5sa+P6I8AokOfAwDgWgQIVObu02cPfH8EZU2AbfQ5AABKI0CgUn7sq3ojvuRKA+bQ5wAAWBoBArXw/RHajficKw40jj4HAMDKCBCole+PUJD4iCsPNII+BwDAWggQaMTdp88e+kZr+iOAetDnAAAIggCBxvj+CIWIv/IsAJWhzwEAEBQBAo3z/RFPGPsKBEWfAwCgEgQImOH7IxQk/sKzAqyFPgcAQGUIEDDn7tNnj/zoV/ojgOXQ5wAAqBwBAib5/ghNa/qCZwi4Fn0OAIDaECBg2t2nz+75IEF/BPA++hwAALUjQCAKd58+e+AnNtEfAczQ5wAAaAQBAtHwZU0P6Y9Ax9HnAABoFAEC0fFjXx/RH4GOoc8BAGACAQLR8mNf1R/xEc8iWow+BwCAKQQIRM/3RzymrAktRJ8DAMAcAgRaYa4/4kueUbSA+hwe/fzZh9/wZAIArCFAoFV8f4R2Iz7nmUWEfvLB4QlPHgDAKgIEWsn3Rzxh7CsiceCD72PKlQAA1hEg0Gp3nz576Cc20R8Bq77yuw4/8gwBAGJAgEDr+f4IhYi/8mzDEPocAABRIkCgM3x/hMqaPuZZR4PocwAARI0Agc65+/TZfV9vTn8E6kSfAwCgFQgQ6Ky7T5898qNf6Y9A1ehzAAC0BgECneb7I3RX+IuuXwtUgj4HAEDrECCAt2NfH9EfgUDocwAAtBYBAphz9+mzBz5I0B+BVdDnAABoPQIEcIEva3pIfwSWRJ8DAKATCBDAFfzYV91N/pxrhAXocwAAdAoBAriG749QkPj92xPMAAADC0lEQVSIa4U59DkAADqJAAGU5PsjHlPW1Hn0OQAAOo0AASxhrj/iS65bJ9HnAADoPAIEsALfH/GEsa+dQZ8DAAAeAQJYg++PeMLY19aizwEAgAsIEEAAd58+e+jPj6A/oh3ocwAA4AoECCAQ3x+hEPFXrmnU6HMAAGABAgQQ2N2nz+75u9f0R8SFPgcAAEogQAAVufv02X0fJOiPsI0+BwAAlkCAACp29+mzR370K/0R9vyNPgcAAJZDgABq4PsjtBvxBdfbhH8q1NHnAADA8ggQQI38+RGPCBKN+cEHB/ocAABYEQECaABBonYHPjjQ5wAAwJoIEECDCBK1oM8BAICACBCAAb5HQo3WD5jaFAznOQAAUAECBGCMH/+qIPE5z81KCA4AAFSIAAEY5cubijDxEc/TQupxeOJLlQgOAABUiAABRIAwcaUf/Hjcr+lxwP/f3r2cNgyEURgd0kA6CF6oAHUQF6BitUgBdgcqwCtVkBLCwCwGguFCINbjHBg8G4Msrz5+PQD4HwICdqaLietJL3Oqb46eTRsA4DUEBOzcx9fj2mKirs+D/p/3Fg2zaACA1xIQcDAtKMYWFONOn+pUg6G+7G1Zp2HewPEAAI2AgINrj4gd27p0+/cN/PJ68/PSr3Ualg0cFwDwhICAE2vTitKmFaUFxqXb/3V6ce/2t/ZZA+F7nYbbk+8AABsmIIBYN834RRAAwDkICAAAIPbmVAEAACkBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAEBMQAAAADEBAQAAxAQEAAAQExAAAECmlPIDmb9AJu2dyFAAAAAASUVORK5CYII=\",\n \"targetType\" : \"TENANT_LEVEL\",\n \"description\" : \"description - updated\",\n \"supportedPlatforms\" : [ {\n \"name\" : \"AZURE\",\n \"kind\" : \"meshPlatformType\"\n } ],\n \"runTransparency\" : false,\n \"useInLandingZonesOnly\" : false,\n \"supportUrl\" : \"https://example.com\",\n \"documentationUrl\" : \"https://example.com\",\n \"notificationSubscriberUsernames\" : [ ]\n },\n \"status\" : {\n \"versions\" : [ {\n \"versionUuid\" : \"b5d96b59-cd43-417b-ac22-f9d0e3066456\",\n \"versionNumber\" : 1,\n \"state\" : \"DRAFT\"\n } ],\n \"latestVersion\" : 1,\n \"latestVersionUuid\" : \"b5d96b59-cd43-417b-ac22-f9d0e3066456\",\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:03.847693682Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/my-workspace\"\n },\n \"buildingblocks\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks?definitionUuid=ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\"\n },\n \"versions\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions?buildingBlockDefinitionUuid=ab4878c8-b75b-42c8-aa0b-6ce4d846a0b3\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Building Block Definitions"
],
"summary": "Delete building block definition",
"description": "Delete a specific meshBuildingBlockDefinition by its unique identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionDeleteV1",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshBuildingBlockDefinition.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockdefinitionversions/{uuid}": {
"get": {
"tags": [
"Building Block Definition Versions"
],
"summary": "Get building block definition version",
"description": "Retrieve detailed information about a specific version of a building block definition including its configuration, state, and implementation details.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionVersion-get-V1-",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshBuildingBlockDefinitionVersion.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionVersion-get-V1-terraform"
},
"examples": {
"meshBuildingBlockDefinitionVersion-get-V1-terraform": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"4110a6fe-7133-4904-84ec-47881e5fb107\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"terraform\",\n \"terraform\" : {\n \"terraformVersion\" : \"1.11.0\",\n \"repositoryUrl\" : \"git@github.com:example/building-block.git\",\n \"async\" : false,\n \"repositoryPath\" : \"path/to/sources\",\n \"refName\" : \"main\",\n \"sshPrivateKey\" : {\n \"hash\" : \"sha256:f11aefcce66c8493feb82c72c36892a42334b6d71055c829a5ac7cbd1fad22fa\"\n },\n \"sshKnownHost\" : {\n \"host\" : \"github.com\",\n \"keyType\" : \"ssh-rsa\",\n \"keyValue\" : \"AAAAB3NzaC1yc2EAAAABIwAAA...\"\n },\n \"useMeshHttpBackendFallback\" : true,\n \"preRunScript\" : \"echo \\\"Running pre-run script\\\"\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"66ddc814-1e69-4dad-b5f1-3a5bce51c01f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:05.808280594Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/4110a6fe-7133-4904-84ec-47881e5fb107\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-get-V1-githubWorkflows": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"8f0adb54-d722-412c-be1f-ec6a8e34c739\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"8794362e-f8a4-49f4-bb81-cad0743a4eed\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"githubWorkflows\",\n \"githubWorkflows\" : {\n \"repository\" : \"git@github.com:example/building-block.git\",\n \"branch\" : \"main\",\n \"applyWorkflow\" : \"apply.yml\",\n \"destroyWorkflow\" : \"destroy.yml\",\n \"async\" : true,\n \"omitRunObjectInput\" : false,\n \"integrationRef\" : {\n \"uuid\" : \"308decb2-8986-4421-bf17-28ba78a2a385\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:06.680656028Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/8f0adb54-d722-412c-be1f-ec6a8e34c739\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/8794362e-f8a4-49f4-bb81-cad0743a4eed\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-get-V1-azureDevOpsPipeline": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"a888ac98-8600-440d-9e4e-9a61f51f7f4a\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"f0c57904-7c4a-4801-95e1-a3b8f3fc5719\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"azureDevOpsPipeline\",\n \"azureDevOpsPipeline\" : {\n \"project\" : \"example-project\",\n \"pipelineId\" : \"pipeline-id\",\n \"async\" : true,\n \"integrationRef\" : {\n \"uuid\" : \"61d30736-29dd-45ff-bcf9-615ad8c8ca12\",\n \"kind\" : \"meshIntegration\"\n },\n \"refName\" : \"refs/heads/feature/my-branch\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:08.335331718Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/a888ac98-8600-440d-9e4e-9a61f51f7f4a\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/f0c57904-7c4a-4801-95e1-a3b8f3fc5719\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-get-V1-manual": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"5d1e4788-4eaa-4c6a-a562-5bed6e008437\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"manual\"\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"46b7c17a-61f0-4062-9601-5785e60ce11f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example\" : {\n \"displayName\" : \"Example\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:04.836460603Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/5d1e4788-4eaa-4c6a-a562-5bed6e008437\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-get-V1-gitlabPipeline": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"83bddae0-2c0c-471d-839c-5f2316e92978\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"gitlabPipeline\",\n \"gitlabPipeline\" : {\n \"projectId\" : \"project-id\",\n \"refName\" : \"main\",\n \"pipelineTriggerToken\" : {\n \"hash\" : \"sha256:dc56154e784a7399cb56d89ee826bba9cddcf1812970c2810ee1bde96cb509cc\"\n },\n \"integrationRef\" : {\n \"uuid\" : \"d4b7f45a-4e7c-4fee-a9d3-51ef1db6da6d\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:07.511169703Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/83bddae0-2c0c-471d-839c-5f2316e92978\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Building Block Definition Versions"
],
"summary": "Update a new Building Block Definition Version",
"description": "Updates an existing Building Block Definition Version.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDefinitionVersion-put-V1-",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json"
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockdefinitionversions-uuid92336749"
},
"examples": {
"meshBuildingBlockDefinitionVersion-put-V1-azureDevOpsPipeline": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \"uuid\": \"a888ac98-8600-440d-9e4e-9a61f51f7f4a\",\n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"f0c57904-7c4a-4801-95e1-a3b8f3fc5719\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"azureDevOpsPipeline\",\"azureDevOpsPipeline\":{\"project\":\"example-project\",\"pipelineId\":\"pipeline-id\",\"async\":true,\"integrationRef\":{\"uuid\":\"61d30736-29dd-45ff-bcf9-615ad8c8ca12\",\"kind\":\"meshIntegration\"},\"refName\":\"refs/heads/feature/my-branch\"}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"05cfa85f-2818-4bdd-b193-620e0187d7de\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-terraform": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \"uuid\": \"4110a6fe-7133-4904-84ec-47881e5fb107\",\n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"terraform\",\"terraform\":{\"terraformVersion\":\"1.11.0\",\"repositoryUrl\":\"git@github.com:example/building-block.git\",\"async\":false,\"repositoryPath\":\"path/to/sources\",\"refName\":\"main\",\"sshPrivateKey\":{\"plaintext\":\"example-secret\"},\"sshKnownHost\":{\"host\":\"github.com\",\"keyType\":\"ssh-rsa\",\"keyValue\":\"AAAAB3NzaC1yc2EAAAABIwAAA...\"},\"useMeshHttpBackendFallback\":true,\"preRunScript\":\"echo \\\"Running pre-run script\\\"\"}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"66ddc814-1e69-4dad-b5f1-3a5bce51c01f\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-githubWorkflows": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \"uuid\": \"8f0adb54-d722-412c-be1f-ec6a8e34c739\",\n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"8794362e-f8a4-49f4-bb81-cad0743a4eed\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"githubWorkflows\",\"githubWorkflows\":{\"repository\":\"git@github.com:example/building-block.git\",\"branch\":\"main\",\"applyWorkflow\":\"apply.yml\",\"destroyWorkflow\":\"destroy.yml\",\"async\":true,\"omitRunObjectInput\":false,\"integrationRef\":{\"uuid\":\"308decb2-8986-4421-bf17-28ba78a2a385\",\"kind\":\"meshIntegration\"}}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-manual": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \"uuid\": \"5d1e4788-4eaa-4c6a-a562-5bed6e008437\",\n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"manual\"},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"PURGE\",\n \"permissions\": [],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"46b7c17a-61f0-4062-9601-5785e60ce11f\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n },\n \n \"outputs\": {\n \"example\": {\n \"displayName\": \"Example\",\n \"type\": \"STRING\",\n \"assignmentType\": \"NONE\"\n }\n }\n \n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-gitlabPipeline": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"metadata\": {\n \"uuid\": \"83bddae0-2c0c-471d-839c-5f2316e92978\",\n \"ownedByWorkspace\": \"docs-bb-version-workspace\"\n },\n \"spec\": {\n \"buildingBlockDefinitionRef\": {\n \"kind\": \"meshBuildingBlockDefinition\",\n \"uuid\": \"d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\"\n },\n \"versionNumber\": 2,\n \"state\": \"DRAFT\",\n \"implementation\": {\"type\":\"gitlabPipeline\",\"gitlabPipeline\":{\"projectId\":\"project-id\",\"refName\":\"main\",\"pipelineTriggerToken\":{\"plaintext\":\"example-secret\"},\"integrationRef\":{\"uuid\":\"d4b7f45a-4e7c-4fee-a9d3-51ef1db6da6d\",\"kind\":\"meshIntegration\"}}},\n \"onlyApplyOncePerTenant\": false, \n \"deletionMode\": \"DELETE\",\n \"permissions\": [\"PROJECT_LIST\", \"PROJECT_SAVE\"],\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\"\n },\n \"dependencyDefinitionUuids\": [\"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\"],\n \"inputs\": {\n \"example\": {\n \"displayName\": \"Example Input\",\n \"description\": \"An example input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"STATIC\",\n \"isEnvironment\": false,\n \"isSensitive\": false,\n \"updateableByConsumer\": true,\n \"defaultValue\": \"test\",\n \"argument\": \"test\",\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n }\n \n ,\n \"example-sensitive-input\": {\n \"displayName\": \"Example Sensitive Input\",\n \"description\": \"An example sensitive input for demonstration purposes\",\n \"type\": \"STRING\",\n \"assignmentType\": \"USER_INPUT\",\n \"isEnvironment\": false,\n \"isSensitive\": true,\n \"updateableByConsumer\": true,\n \"valueValidationRegex\": null,\n \"validationRegexErrorMessage\": null,\n \"selectableValues\": null\n } \n },\n \n \"outputs\": {\n \"example-output\": {\n \"displayName\": \"Example Output\",\n \"type\": \"STRING\",\n \"assignmentType\": \"SUMMARY\"\n }\n }\n \n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockdefinitionversion.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockDefinitionVersion-put-V1-azureDevOpsPipeline"
},
"examples": {
"meshBuildingBlockDefinitionVersion-put-V1-azureDevOpsPipeline": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"a888ac98-8600-440d-9e4e-9a61f51f7f4a\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"f0c57904-7c4a-4801-95e1-a3b8f3fc5719\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"azureDevOpsPipeline\",\n \"azureDevOpsPipeline\" : {\n \"project\" : \"example-project\",\n \"pipelineId\" : \"pipeline-id\",\n \"async\" : true,\n \"integrationRef\" : {\n \"uuid\" : \"61d30736-29dd-45ff-bcf9-615ad8c8ca12\",\n \"kind\" : \"meshIntegration\"\n },\n \"refName\" : \"refs/heads/feature/my-branch\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:08.335331718Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/a888ac98-8600-440d-9e4e-9a61f51f7f4a\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/f0c57904-7c4a-4801-95e1-a3b8f3fc5719\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-terraform": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"4110a6fe-7133-4904-84ec-47881e5fb107\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"terraform\",\n \"terraform\" : {\n \"terraformVersion\" : \"1.11.0\",\n \"repositoryUrl\" : \"git@github.com:example/building-block.git\",\n \"async\" : false,\n \"repositoryPath\" : \"path/to/sources\",\n \"refName\" : \"main\",\n \"sshPrivateKey\" : {\n \"hash\" : \"sha256:b34e0aca1509b8f63d0a0204bb84c43546c06dd0a48abc1a51e27c978136c3b0\"\n },\n \"sshKnownHost\" : {\n \"host\" : \"github.com\",\n \"keyType\" : \"ssh-rsa\",\n \"keyValue\" : \"AAAAB3NzaC1yc2EAAAABIwAAA...\"\n },\n \"useMeshHttpBackendFallback\" : true,\n \"preRunScript\" : \"echo \\\"Running pre-run script\\\"\"\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"66ddc814-1e69-4dad-b5f1-3a5bce51c01f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:05.808280594Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/4110a6fe-7133-4904-84ec-47881e5fb107\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/a279d73f-01dd-4e17-89ed-3ab3f02a3f4f\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-githubWorkflows": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"8f0adb54-d722-412c-be1f-ec6a8e34c739\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"8794362e-f8a4-49f4-bb81-cad0743a4eed\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"githubWorkflows\",\n \"githubWorkflows\" : {\n \"repository\" : \"git@github.com:example/building-block.git\",\n \"branch\" : \"main\",\n \"applyWorkflow\" : \"apply.yml\",\n \"destroyWorkflow\" : \"destroy.yml\",\n \"async\" : true,\n \"omitRunObjectInput\" : false,\n \"integrationRef\" : {\n \"uuid\" : \"308decb2-8986-4421-bf17-28ba78a2a385\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:06.680656028Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/8f0adb54-d722-412c-be1f-ec6a8e34c739\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/8794362e-f8a4-49f4-bb81-cad0743a4eed\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-manual": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"5d1e4788-4eaa-4c6a-a562-5bed6e008437\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"manual\"\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"PURGE\",\n \"runnerRef\" : {\n \"uuid\" : \"46b7c17a-61f0-4062-9601-5785e60ce11f\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example\" : {\n \"displayName\" : \"Example\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:04.836460603Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/5d1e4788-4eaa-4c6a-a562-5bed6e008437\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/48d56ed7-cfbe-4716-ad2f-59c5bcd50d76\"\n }\n }\n}"
},
"meshBuildingBlockDefinitionVersion-put-V1-gitlabPipeline": {
"value": "{\n \"kind\" : \"meshBuildingBlockDefinitionVersion\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"83bddae0-2c0c-471d-839c-5f2316e92978\",\n \"ownedByWorkspace\" : \"docs-bb-version-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionRef\" : {\n \"uuid\" : \"d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n },\n \"versionNumber\" : 2,\n \"state\" : \"DRAFT\",\n \"implementation\" : {\n \"type\" : \"gitlabPipeline\",\n \"gitlabPipeline\" : {\n \"projectId\" : \"project-id\",\n \"refName\" : \"main\",\n \"pipelineTriggerToken\" : {\n \"hash\" : \"sha256:1cc75ffe17505a665abbf809f45babf600e16725752d4d0fe0d2b9fcc0a49c42\"\n },\n \"integrationRef\" : {\n \"uuid\" : \"d4b7f45a-4e7c-4fee-a9d3-51ef1db6da6d\",\n \"kind\" : \"meshIntegration\"\n }\n }\n },\n \"onlyApplyOncePerTenant\" : false,\n \"deletionMode\" : \"DELETE\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n },\n \"permissions\" : [ \"PROJECT_LIST\", \"PROJECT_SAVE\" ],\n \"dependencyDefinitionUuids\" : [ \"56d99a43-b435-4f9f-b80f-b776e9a3b5cc\" ],\n \"inputs\" : {\n \"example\" : {\n \"displayName\" : \"Example Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"STATIC\",\n \"argument\" : \"test\",\n \"isEnvironment\" : false,\n \"isSensitive\" : false,\n \"updateableByConsumer\" : true,\n \"defaultValue\" : \"test\",\n \"description\" : \"An example input for demonstration purposes\"\n },\n \"example-sensitive-input\" : {\n \"displayName\" : \"Example Sensitive Input\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"USER_INPUT\",\n \"isEnvironment\" : false,\n \"isSensitive\" : true,\n \"updateableByConsumer\" : true,\n \"description\" : \"An example sensitive input for demonstration purposes\"\n }\n },\n \"outputs\" : {\n \"example-output\" : {\n \"displayName\" : \"Example Output\",\n \"type\" : \"STRING\",\n \"assignmentType\" : \"SUMMARY\"\n }\n }\n },\n \"status\" : {\n \"state\" : \"DRAFT\",\n \"usageCount\" : 0,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:07.511169703Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitionversions/83bddae0-2c0c-471d-839c-5f2316e92978\"\n },\n \"buildingBlockDefinition\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockdefinitions/d2683f3c-052f-4ef5-a7d0-25aa7c265d1c\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockrunners/{buildingBlockRunnerUuid}": {
"get": {
"tags": [
"Building Block Runners"
],
"summary": "Get building block runner",
"description": "Retrieve a single meshBuildingBlockRunner by its UUID.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunner-Get",
"parameters": [
{
"name": "buildingBlockRunnerUuid",
"in": "path",
"description": "The UUID of the meshBuildingBlockRunner to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunner-Get"
},
"examples": {
"meshBuildingBlockRunner-Get": {
"value": "{\n \"kind\" : \"meshBuildingBlockRunner\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"40986235-fb2a-440f-9bcd-292fbad9ca08\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"createdOn\" : \"2026-06-03T14:05:10.656878818Z\",\n \"lastSeen\" : \"2026-06-03T14:05:10.656878818Z\"\n },\n \"spec\" : {\n \"displayName\" : \"my-terraform-runner\",\n \"publicKey\" : \"-----BEGIN CERTIFICATE-----\\nMIIE/zCCAuegAwIBAgIUCSNWLAVNiOYz0XnhGTh4sZr2/8YwDQYJKoZIhvcNAQEL\\nBQAwDzENMAsGA1UEAwwEdGVzdDAeFw0yNTA5MTkwODU4MTFaFw0yNjA5MTkwODU4\\nMTFaMA8xDTALBgNVBAMMBHRlc3QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK\\nAoICAQC9NNiRNKS4nunZ02vi8goUfn3HH8KhPVOtvpTDcb7omOyGAq66uXqZxa3o\\n3eZu3RGCEIooXHlv2zBcT7Hz7OovmJEEhH4+OfH+ZDXFAYUgvOz/NuuwSQgCpSow\\nX/q8m7eESFb8X7ldu8s5SsJ2JFLjIyxVoX2wGDXUZnJVujIxjTj32MdokxKXkrxd\\ncwS6vzpNZp8E6F6pdBke6dKhb+24Gra3/ISqjmTf5VMMSLBKDEe8CUbEELzIkbXG\\nTj1z3xu3NdpVD4i9Q6pa4bYSeSexybVWPBHYM3SEVfcvyqks/WhQDhISgYaTVtDA\\nSQ+Tln24JMmUHs5ENl/wYnJY5ovDSWoolNMiQY7XddQImmxZ8zmBU+2hViDQq4W+\\nBQn8miOoBww1GUjxUCKDgBGzDSu3SvP1o2K4U5L0TAIg5W6JgN/+333AQ7iIRErc\\nEGO82ftzNiP/eHXz2S6Z97BBHGVHFrxJUPho9lVd5MrvKhqRZULiGIPmqgtZNMJo\\nWnD1UlMjJQOsf2K0qaiMW32738azLQ8oBWQ05tpXUh0ChfvKSpYPoSGp0QWV+U8O\\nGMUGSBdILISagFMn4zWy67JBWRDYuNmuzrBgWe8ZhLAMhNtRPG8SZIy0Xp+g0GUN\\n6/LIDuk1zTHAwC2CaNBJgRJOleheNtQOBY8hhAVWlHLrkB4bDQIDAQABo1MwUTAd\\nBgNVHQ4EFgQUHVo5FXwCa2ou5ahhk7OJXElQ0/gwHwYDVR0jBBgwFoAUHVo5FXwC\\na2ou5ahhk7OJXElQ0/gwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOC\\nAgEACkflInpnLpcBFSkG3IFN5EEDM5HEUnnu01M/GTbPATC8umWDxKKNxdl5jkZd\\nLtrS7U8LTwleM2rktRBL7jq/oUbJaQLw78AaK3cc/6S/p7nq7DdWhgqFOj3+H+Ik\\n+XEcco6vET6R0Ow1Lqt9f3JV9xq93WwZeYGBZ4mP3hrmacQf7GPCJgdS8dy1H2fq\\nCt0DxPHYnKgkEr7e3MJBpGrpq5A5g9uJNWDLhs7s2FvjW7kFUTj1OsJDRU7Bc8eY\\nXXgUOb8lRPc9wE5TN2RZ5Ghp82jAxuSh8syD28AoIHq8UIaBrTUYnTB06j7IiaZ7\\nkOylLkCH4rrbOFW9N8XutHjUNu9gxtv1v94nzWuT5RX1/cqazjHSnqykjNsT3ZcX\\nOxGNjIIGsFh7bOnsZ7U+lmOmfmUkxBWrpHcw4dTe2OzhiccjoSDtWsQOPANmGgzY\\n8Iemh6v5zXM3sYHzJliswpawNLv9sNPkIb0NGiRWs2VimbaYrE4404EXRllKUJwj\\n2OROpr2uw86pPOyhpNaJjGyoJPOM71Wvx8vqUoINFRJRsj62uEWYpcN1+b4835S/\\nizawL1nW2+w6+DVnXu4oRotQ40MOW9DSESZoKnA0sJZ9KkOEkthBHmlErKa9iq/1\\nEsPBbtuo0C0zB4k9MPfbmkmLy0oQBZNBjDbkeCHWPxtPExY=\\n-----END CERTIFICATE-----\",\n \"implementationType\" : \"TERRAFORM\",\n \"restriction\" : \"PRIVATE\",\n \"isSelfHosted\" : true\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockrunners/40986235-fb2a-440f-9bcd-292fbad9ca08\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Building Block Runners"
],
"summary": "Update building block runner",
"description": "Update an existing meshBuildingBlockRunner. All fields in the request body replace the existing values.\n\nThe `metadata.uuid` in the request body is optional. If provided, it must match the `{buildingBlockRunnerUuid}` path parameter.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunner-Put",
"parameters": [
{
"name": "buildingBlockRunnerUuid",
"in": "path",
"description": "The UUID of the meshBuildingBlockRunner to update.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockrunners-buildingBlockRunnerUuid816872201"
},
"examples": {
"meshBuildingBlockRunner-Put": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshBuildingBlockRunner\",\n \"metadata\": {\n \"uuid\": \"40986235-fb2a-440f-9bcd-292fbad9ca08\",\n \"ownedByWorkspace\": \"platform-team\"\n },\n \"spec\": {\n \"displayName\": \"My Updated Terraform Runner\",\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----\\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAqy2py5uFX9LfQgiM2Zd+\\nQm1NcZWKX8TqCQJKZ0Qa9R+BoERbVBoLM4DdY67DAr6b1E08QRfI2EnF0w6zJ7R/\\n0oAkba0lLnT5S9FX6OVUzDvGDOc+5JqBwlK2UibJLmBhX0qnDMvRWBrJLV71yTHj\\njOThfVwNzVaijwmV+y8BQKa6PnoHixuiAoKYCUe4UrEke0tPdstIvrUY/gb9sU57\\nwkfBhYv+RnHuLT1IOGm/uidUMj94jd5mSjYPcuwcVfjTXS8+6TXH5kdqMfigPOER\\n5bmfgBOlJWQUeGojApLJLmSgpVZAIKDHK6i0IzB7QkGRma5llqXVbwnYP+0fOJkR\\nmwGj5FL7M30akGrT2MCslebQ/y+hV/3tnWSfONCWqs3S8yU/mHDMj+DoileGAVmF\\nMjH16sRbA5H3sMjhU49hVDGxaP6FVVK3H0GuPE+WDXRqhhdwPsgLjNAj4P1K0VPL\\nM8gadyGuZjiP4OH3o0sBQcF6cIP6cyK/ms1Y6qg9elqI9RisbGL9WIAVRuPWulsR\\n0AksHEI864yD/Kp2y5QhRO2G7Zl0tc4Wu7mU6Gdb7lRDjZEOm9ArpsWpnp37Tl5a\\nYfm5/6ybSx3X7B57F1PxIqQILT0xSeuyXSiXdRPJesot0Un8/U9SWW7vSiYq4ibA\\nwvivfHtouj93yaMWdLlqodUCAwEAAQ==\\n-----END PUBLIC KEY-----\",\n \"implementationType\": \"TERRAFORM\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunner-Put"
},
"examples": {
"meshBuildingBlockRunner-Put": {
"value": "{\n \"kind\" : \"meshBuildingBlockRunner\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"40986235-fb2a-440f-9bcd-292fbad9ca08\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"createdOn\" : \"2026-06-03T14:05:10.656878818Z\",\n \"lastSeen\" : \"2026-06-03T14:05:10.656878818Z\"\n },\n \"spec\" : {\n \"displayName\" : \"My Updated Terraform Runner\",\n \"publicKey\" : \"-----BEGIN PUBLIC KEY-----\\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAqy2py5uFX9LfQgiM2Zd+\\nQm1NcZWKX8TqCQJKZ0Qa9R+BoERbVBoLM4DdY67DAr6b1E08QRfI2EnF0w6zJ7R/\\n0oAkba0lLnT5S9FX6OVUzDvGDOc+5JqBwlK2UibJLmBhX0qnDMvRWBrJLV71yTHj\\njOThfVwNzVaijwmV+y8BQKa6PnoHixuiAoKYCUe4UrEke0tPdstIvrUY/gb9sU57\\nwkfBhYv+RnHuLT1IOGm/uidUMj94jd5mSjYPcuwcVfjTXS8+6TXH5kdqMfigPOER\\n5bmfgBOlJWQUeGojApLJLmSgpVZAIKDHK6i0IzB7QkGRma5llqXVbwnYP+0fOJkR\\nmwGj5FL7M30akGrT2MCslebQ/y+hV/3tnWSfONCWqs3S8yU/mHDMj+DoileGAVmF\\nMjH16sRbA5H3sMjhU49hVDGxaP6FVVK3H0GuPE+WDXRqhhdwPsgLjNAj4P1K0VPL\\nM8gadyGuZjiP4OH3o0sBQcF6cIP6cyK/ms1Y6qg9elqI9RisbGL9WIAVRuPWulsR\\n0AksHEI864yD/Kp2y5QhRO2G7Zl0tc4Wu7mU6Gdb7lRDjZEOm9ArpsWpnp37Tl5a\\nYfm5/6ybSx3X7B57F1PxIqQILT0xSeuyXSiXdRPJesot0Un8/U9SWW7vSiYq4ibA\\nwvivfHtouj93yaMWdLlqodUCAwEAAQ==\\n-----END PUBLIC KEY-----\",\n \"implementationType\" : \"TERRAFORM\",\n \"restriction\" : \"PRIVATE\",\n \"isSelfHosted\" : true\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockrunners/40986235-fb2a-440f-9bcd-292fbad9ca08\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Building Block Runners"
],
"summary": "Delete building block runner",
"description": "Delete a meshBuildingBlockRunner. A runner can only be deleted when it is not referenced by any\nactive building block definition version.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunner-Delete",
"parameters": [
{
"name": "buildingBlockRunnerUuid",
"in": "path",
"description": "The UUID of the meshBuildingBlockRunner to delete.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrunner.v1-preview.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockruns/create": {
"post": {
"tags": [
"Building Block Runs"
],
"summary": "Fetch a pending building block run",
"description": "Fetch a meshBuildingBlockRun pending execution by a specific runner\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunCreate",
"parameters": [
{
"name": "forRunnerUuid",
"in": "query",
"description": "UUID of the runner. This returns runs which should run on this specific block runner.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json"
},
{
"name": "X-Meshcloud-Runner-Version",
"in": "header",
"description": "Optional header sent by the runner to report its version to meshStack. When provided, meshStack records this as the runner's `metadata.lastKnownVersion`.",
"required": false,
"schema": {
"type": "string"
},
"example": "1.2.3"
}
],
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunCreate"
},
"examples": {
"meshBuildingBlockRunCreate": {
"value": "{\n \"kind\" : \"meshBuildingBlockRun\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"54294ba4-6b6e-4321-b5b6-ea29c4bf610a\"\n },\n \"spec\" : {\n \"runNumber\" : 1,\n \"buildingBlock\" : {\n \"uuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"spec\" : {\n \"displayName\" : \"block\",\n \"workspaceIdentifier\" : \"my-workspace\",\n \"projectIdentifier\" : \"my-project\",\n \"fullPlatformIdentifier\" : \"my-platform.my-location\",\n \"inputs\" : [ {\n \"key\" : \"input-1\",\n \"value\" : \"test\",\n \"type\" : \"STRING\",\n \"isSensitive\" : false,\n \"isEnvironment\" : false\n } ],\n \"parentBuildingBlocks\" : [ ]\n }\n },\n \"buildingBlockDefinition\" : {\n \"uuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"spec\" : {\n \"workspaceIdentifier\" : \"my-workspace\",\n \"version\" : 1,\n \"implementation\" : {\n \"type\" : \"TERRAFORM\",\n \"terraformVersion\" : \"v1\",\n \"repositoryUrl\" : \"https://example.com\",\n \"async\" : true,\n \"useMeshHttpBackendFallback\" : false\n }\n }\n },\n \"behavior\" : \"APPLY\",\n \"runToken\" : \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJPdXJGaUduQnB2QlZNY2NBRjVNT1J3bTA3ODRObHZHRlFXSjlmdm8wTklzIn0.eyJleHAiOjE3ODA0OTU2MzEsImlhdCI6MTc4MDQ5NTUxMiwianRpIjoidHJydGNjOjhjMGZjMGU5LTNiMDQtODQwMC0wNzhiLTAxZWM3YWIyYWQzYSIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NTA1MC9hdXRoL3JlYWxtcy9tZXNoZmVkIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQyNzc0OTI1LWQxY2EtNDUxYi1iZTVkLWNiNjYyZWQwMTlhNyIsInR5cCI6IkJlYXJlciIsImF6cCI6IjM2NDVlNDU2LTdiNGItNDM4Mi04Y2EwLTZkMDg1YWU3NGJmYyIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLW1lc2hmZWQiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImNsaWVudEhvc3QiOiIxMjcuMC4wLjEiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByZWZlcnJlZF91c2VybmFtZSI6InNlcnZpY2UtYWNjb3VudC0zNjQ1ZTQ1Ni03YjRiLTQzODItOGNhMC02ZDA4NWFlNzRiZmMiLCJjbGllbnRBZGRyZXNzIjoiMTI3LjAuMC4xIiwiY2xpZW50X2lkIjoiMzY0NWU0NTYtN2I0Yi00MzgyLThjYTAtNmQwODVhZTc0YmZjIn0.HthkyxKG2kbVsnBSOQd-LIHKkGv_SV-_WTWIVnyRzFvtjgreGr_YsMyz4tNxPK8GsxHkBalFFORxdiUz_9S-UYgfj5wV7wK2Bth8YLeuJrerHBkQvevuoFh4JgLqvMnSuqbgDmlpW90fdGRqdlO4KRgYrFcs4tX6B33VQkTTZQoQThmljPmlCBA1L0CEKIFp_cPJhS46zHS7hwnM2eKPXQuen3ymMz3SB7B4xerrg3qrGaPkvz6oMSPXmIKxsqxkiCQSZjsOtXPFakBSEoh9mO7Bo1bPGw0V1uRcvJUEqNa5-NIubfZ1b1qq8MNQS8h6hlKccoUYj-K0KIH7eNgb6w\"\n },\n \"status\" : \"IN_PROGRESS\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a\"\n },\n \"downloadLogs\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/logs\"\n },\n \"registerSource\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/status/source\"\n },\n \"updateSource\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/status/source/{sourceId}\",\n \"templated\" : true\n },\n \"meshstackBaseUrl\" : {\n \"href\" : \"https://mesh-backend-url\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockruns/{blockRunUuid}": {
"get": {
"tags": [
"Building Block Runs"
],
"summary": "Get a building block run",
"description": "Retrieve details of a specific meshBuildingBlockRun by its UUID.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunGet",
"parameters": [
{
"name": "blockRunUuid",
"in": "path",
"description": "The UUID of the meshBuildingBlockRun to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunGet"
},
"examples": {
"meshBuildingBlockRunGet": {
"value": "{\n \"kind\" : \"meshBuildingBlockRun\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"54294ba4-6b6e-4321-b5b6-ea29c4bf610a\"\n },\n \"spec\" : {\n \"runNumber\" : 1,\n \"buildingBlock\" : {\n \"uuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"spec\" : {\n \"displayName\" : \"block\",\n \"workspaceIdentifier\" : \"my-workspace\",\n \"projectIdentifier\" : \"my-project\",\n \"fullPlatformIdentifier\" : \"my-platform.my-location\",\n \"inputs\" : [ {\n \"key\" : \"input-1\",\n \"value\" : \"test\",\n \"type\" : \"STRING\",\n \"isSensitive\" : false,\n \"isEnvironment\" : false\n } ],\n \"parentBuildingBlocks\" : [ ]\n }\n },\n \"buildingBlockDefinition\" : {\n \"uuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"spec\" : {\n \"workspaceIdentifier\" : \"my-workspace\",\n \"version\" : 1,\n \"implementation\" : {\n \"type\" : \"TERRAFORM\",\n \"terraformVersion\" : \"v1\",\n \"repositoryUrl\" : \"https://example.com\",\n \"async\" : true,\n \"useMeshHttpBackendFallback\" : false\n }\n }\n },\n \"behavior\" : \"APPLY\",\n \"runToken\" : \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJPdXJGaUduQnB2QlZNY2NBRjVNT1J3bTA3ODRObHZHRlFXSjlmdm8wTklzIn0.eyJleHAiOjE3ODA0OTU2MzEsImlhdCI6MTc4MDQ5NTUxMiwianRpIjoidHJydGNjOjhjMGZjMGU5LTNiMDQtODQwMC0wNzhiLTAxZWM3YWIyYWQzYSIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NTA1MC9hdXRoL3JlYWxtcy9tZXNoZmVkIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQyNzc0OTI1LWQxY2EtNDUxYi1iZTVkLWNiNjYyZWQwMTlhNyIsInR5cCI6IkJlYXJlciIsImF6cCI6IjM2NDVlNDU2LTdiNGItNDM4Mi04Y2EwLTZkMDg1YWU3NGJmYyIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJkZWZhdWx0LXJvbGVzLW1lc2hmZWQiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImNsaWVudEhvc3QiOiIxMjcuMC4wLjEiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInByZWZlcnJlZF91c2VybmFtZSI6InNlcnZpY2UtYWNjb3VudC0zNjQ1ZTQ1Ni03YjRiLTQzODItOGNhMC02ZDA4NWFlNzRiZmMiLCJjbGllbnRBZGRyZXNzIjoiMTI3LjAuMC4xIiwiY2xpZW50X2lkIjoiMzY0NWU0NTYtN2I0Yi00MzgyLThjYTAtNmQwODVhZTc0YmZjIn0.HthkyxKG2kbVsnBSOQd-LIHKkGv_SV-_WTWIVnyRzFvtjgreGr_YsMyz4tNxPK8GsxHkBalFFORxdiUz_9S-UYgfj5wV7wK2Bth8YLeuJrerHBkQvevuoFh4JgLqvMnSuqbgDmlpW90fdGRqdlO4KRgYrFcs4tX6B33VQkTTZQoQThmljPmlCBA1L0CEKIFp_cPJhS46zHS7hwnM2eKPXQuen3ymMz3SB7B4xerrg3qrGaPkvz6oMSPXmIKxsqxkiCQSZjsOtXPFakBSEoh9mO7Bo1bPGw0V1uRcvJUEqNa5-NIubfZ1b1qq8MNQS8h6hlKccoUYj-K0KIH7eNgb6w\"\n },\n \"status\" : \"IN_PROGRESS\",\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a\"\n },\n \"downloadLogs\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/logs\"\n },\n \"registerSource\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/status/source\"\n },\n \"updateSource\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblockruns/54294ba4-6b6e-4321-b5b6-ea29c4bf610a/status/source/{sourceId}\",\n \"templated\" : true\n },\n \"meshstackBaseUrl\" : {\n \"href\" : \"https://mesh-backend-url\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblocks/{uuid}": {
"get": {
"tags": [
"Building Blocks"
],
"summary": "Get building block",
"description": "Retrieve detailed information about a specific meshBuildingBlock including inputs, outputs, and parent relationships\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlock",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID of the meshBuildingBlock to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockV2"
},
"examples": {
"meshBuildingBlockV2": {
"value": "{\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v2-preview\",\n \"metadata\" : {\n \"uuid\" : \"5646eafe-5d56-43e5-84fe-329bb050d720\",\n \"ownedByWorkspace\" : \"my-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\" : {\n \"uuid\" : \"63f13d8f-aeee-4099-a042-abaea7ecb059\",\n \"kind\" : \"meshBuildingBlockDefinitionVersion\"\n },\n \"targetRef\" : {\n \"uuid\" : \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\",\n \"kind\" : \"meshTenant\"\n },\n \"displayName\" : \"child block\",\n \"inputs\" : {\n \"resourceName\" : {\n \"value\" : \"My Test Resource\",\n \"valueType\" : \"STRING\",\n \"isSensitive\" : false,\n \"assignmentType\" : \"USER_INPUT\",\n \"updateableByConsumer\" : false\n }\n },\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"SUCCEEDED\",\n \"outputs\" : {\n \"resourceId\" : {\n \"value\" : \"id-123\",\n \"valueType\" : \"STRING\",\n \"assignmentType\" : \"NONE\"\n }\n },\n \"latestRunUuid\" : \"8d78a427-f31d-4005-a0ad-fce2fd0652a5\",\n \"forcePurge\" : false,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:13.269320880Z\"\n }\n },\n \"_links\" : {\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720/purge\"\n }\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlock"
},
"examples": {
"meshBuildingBlock": {
"value": "{\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"5646eafe-5d56-43e5-84fe-329bb050d720\",\n \"definitionUuid\" : \"ef6aaf87-3f8c-477c-94f4-f3cf509728ca\",\n \"definitionVersion\" : 1,\n \"tenantIdentifier\" : \"my-workspace.my-project.my-platform.my-location\",\n \"forcePurge\" : false,\n \"createdOn\" : \"2026-06-03T14:05:09.124361364Z\"\n },\n \"spec\" : {\n \"displayName\" : \"child block\",\n \"inputs\" : [ {\n \"key\" : \"resourceName\",\n \"value\" : \"My Test Resource\",\n \"valueType\" : \"STRING\"\n } ],\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"68ce5455-2a4a-4a4b-a324-6a6c18cab85a\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"SUCCEEDED\",\n \"outputs\" : [ {\n \"key\" : \"resourceId\",\n \"value\" : \"id-123\",\n \"valueType\" : \"STRING\"\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720\"\n },\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5646eafe-5d56-43e5-84fe-329bb050d720/purge\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Building Blocks"
],
"summary": "Update building block",
"description": "Update a meshBuildingBlock in place. Only `spec.inputs` may be changed; all other fields (displayName, targetRef, parentBuildingBlocks, buildingBlockDefinitionVersionRef) must match the existing resource. Only inputs with assignment type `CUSTOMER_INPUT` or `PLATFORM_OPERATOR_MANUAL_INPUT` can be updated. Inputs with assignment type `STATIC` are rejected. Note that the building block definition may be owned by a different workspace than the one owning the building block itself. API keys with workspace-scoped permissions (e.g. 'Manage Building Blocks for owned definition') can update building blocks created from definitions owned by that workspace, even if the building block resides on a tenant in another workspace.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockPutV2",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID of the meshBuildingBlock to update.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblocks-uuid-836471433"
},
"examples": {
"meshBuildingBlockPutV2": {
"value": "{\n \"apiVersion\" : \"v2-preview\",\n \"kind\" : \"meshBuildingBlock\",\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\": {\n \"kind\": \"meshBuildingBlockDefinitionVersion\",\n \"uuid\": \"63f13d8f-aeee-4099-a042-abaea7ecb059\"\n },\n \"targetRef\": {\n \"kind\": \"meshTenant\",\n \"uuid\": \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\"\n },\n \"displayName\" : \"New BuildingBlock v2\",\n \"inputs\" : {\n \"resourceName\": {\n \"value\": \"updated-resource-name\",\n \"valueType\": \"STRING\"\n }\n },\n \"parentBuildingBlocks\" : [{\n \"definitionUuid\": \"b23cfb9a-6974-444f-9d33-62134a632373\",\n \"buildingBlockUuid\": \"9ea5cf31-6475-4489-b70b-74113d78ba83\"\n }]\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockPutV2"
},
"examples": {
"meshBuildingBlockPutV2": {
"value": "{\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v2-preview\",\n \"metadata\" : {\n \"uuid\" : \"db435958-06f1-472f-8c24-a82ba1ba2f6f\",\n \"ownedByWorkspace\" : \"my-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\" : {\n \"uuid\" : \"63f13d8f-aeee-4099-a042-abaea7ecb059\",\n \"kind\" : \"meshBuildingBlockDefinitionVersion\"\n },\n \"targetRef\" : {\n \"uuid\" : \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\",\n \"kind\" : \"meshTenant\"\n },\n \"displayName\" : \"New BuildingBlock v2\",\n \"inputs\" : {\n \"resourceName\" : {\n \"value\" : \"updated-resource-name\",\n \"valueType\" : \"STRING\",\n \"isSensitive\" : false,\n \"assignmentType\" : \"USER_INPUT\",\n \"updateableByConsumer\" : false\n }\n },\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"9ea5cf31-6475-4489-b70b-74113d78ba83\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"PENDING\",\n \"outputs\" : { },\n \"forcePurge\" : false,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:14.150666874Z\"\n }\n },\n \"_links\" : {\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/db435958-06f1-472f-8c24-a82ba1ba2f6f\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/db435958-06f1-472f-8c24-a82ba1ba2f6f/purge\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Building Blocks"
],
"summary": "Delete building block",
"description": "Delete a meshBuildingBlock and mark it for removal. Depending on the deletion mode of the\nmeshBuildingBlock's version, the meshBuildingBlock will either be removed (including potential\ncloud resources) or purged (removed from meshStack only).\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockDelete",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshBuildingBlock.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshcommunicationdefinitions/{uuid}": {
"get": {
"tags": [
"Communication Definitions"
],
"summary": "Get communication definition",
"description": "Retrieve detailed information about a specific meshCommunicationDefinition\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationDefinition",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshCommunicationDefinition.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshCommunicationDefinition"
},
"examples": {
"meshCommunicationDefinition": {
"value": "{\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"36bfc8d8-37ac-4513-979c-fb6970170dbf\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"Communication definition 1 Title\",\n \"message\" : \"Message for Communication definition 1. Use [this guide](http://example.com/1) for reference.\",\n \"dueDate\" : \"2026-06-04\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/36bfc8d8-37ac-4513-979c-fb6970170dbf\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Communication Definitions"
],
"summary": "Update communication definition",
"description": "Update an existing meshCommunicationDefinition with new communication details\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationDefinitionPut",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshCommunicationDefinition.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json"
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshcommunicationdefinitions-uuid1963883446"
},
"examples": {
"meshCommunicationDefinitionPut": {
"value": "{\n \"apiVersion\": \"v1-preview\",\n \"kind\": \"meshCommunicationDefinition\",\n \"spec\": {\n \"communication\": {\n \"title\": \"my-new-title\",\n \"message\": \"my-new-message\",\n \"dueDate\": \"2099-05-31\",\n \"type\": \"ACTION_REQUIRED\"\n }\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshCommunicationDefinitionPut"
},
"examples": {
"meshCommunicationDefinitionPut": {
"value": "{\n \"kind\" : \"meshCommunicationDefinition\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"36bfc8d8-37ac-4513-979c-fb6970170dbf\"\n },\n \"spec\" : {\n \"communication\" : {\n \"title\" : \"my-new-title\",\n \"message\" : \"my-new-message\",\n \"dueDate\" : \"2099-05-31\",\n \"type\" : \"ACTION_REQUIRED\",\n \"skipEmailNotifications\" : false\n }\n },\n \"status\" : {\n \"communicationsTotal\" : 0,\n \"communicationsResolved\" : 0,\n \"communicationsOpen\" : 0\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunicationdefinitions/36bfc8d8-37ac-4513-979c-fb6970170dbf\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Communication Definitions"
],
"summary": "Delete communication definition",
"description": "Delete a specific meshCommunicationDefinition by its unique identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationDefinitionDelete",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshCommunicationDefinition.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunicationdefinition.v1-preview.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshcommunications/{uuid}": {
"get": {
"tags": [
"Communications"
],
"summary": "Get communication",
"description": "Retrieve detailed information about a specific meshCommunication\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunication",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID that uniquely identifies the meshCommunication.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "meshApi is versioned and you should use `application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json` as an `Accept` header to be guaranteed the V1 response format of this endpoint. New versions will be added in future.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshcommunication.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshCommunication"
},
"examples": {
"meshCommunication": {
"value": "{\n \"kind\" : \"meshCommunication\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"c0475220-f157-4775-80f5-5e205e5e1163\",\n \"ownedByWorkspace\" : \"my-workspace-identifier\"\n },\n \"spec\" : {\n \"targetMeshObjectRef\" : {\n \"kind\" : \"meshWorkspace\",\n \"name\" : \"my-workspace-identifier\"\n },\n \"communicationDefinitionRef\" : {\n \"uuid\" : \"b0c0e088-cea8-4516-b989-553502018cc6\",\n \"kind\" : \"meshCommunicationDefinition\"\n }\n },\n \"status\" : {\n \"resolutionStatus\" : \"OPEN\",\n \"meshCommunicationDefinition\" : {\n \"uuid\" : \"b0c0e088-cea8-4516-b989-553502018cc6\",\n \"title\" : \"Communication definition 1 Title\",\n \"dueDate\" : \"2026-06-04\",\n \"communicationType\" : \"ACTION_REQUIRED\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshcommunications/c0475220-f157-4775-80f5-5e205e5e1163\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Communications"
],
"summary": "Delete communication",
"description": "Delete a meshCommunication to remove it from the system\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshCommunicationDelete",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshCommunication.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/mesheventlogs/{uuid}": {
"get": {
"tags": [
"Event Logs"
],
"summary": "Get event log",
"description": "Get a single meshEventLog by its UUID.\n\nEvent logs are read-only records that provide detailed information about actions\nthat have occurred in meshStack. Each event log contains metadata about when it\nwas created, the type of event, and detailed content describing what happened.\n\n**Access Control:**\n- Admin users can access any event log\n- Regular users can only access event logs from their own workspace\n\n**Authentication:** This endpoint supports multiple authentication methods: API Key authentication or API User authentication.",
"operationId": "meshEventLog",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID that uniquely identifies the meshEventLog.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.mesheventlog.v1-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshEventLog"
},
"examples": {
"meshEventLog": {
"value": "{\n \"kind\" : \"meshEventLog\",\n \"apiVersion\" : \"v1-preview\",\n \"metadata\" : {\n \"uuid\" : \"a4eba1b1-d635-4fc5-b3f6-c656373774f3\",\n \"createdAt\" : \"2024-01-15T10:30:00Z\"\n },\n \"spec\" : {\n \"title\" : \"Workspace Name Changed\",\n \"eventType\" : \"Changed\",\n \"description\" : \"Workspace Workspace ABC was changed to Workspace XYZ\",\n \"workspaceRef\" : {\n \"name\" : \"my-workspace\",\n \"kind\" : \"meshWorkspace\"\n },\n \"content\" : {\n \"name\" : \"Workspace XYZ\"\n },\n \"previousContent\" : {\n \"name\" : \"Workspace ABC\"\n },\n \"author\" : {\n \"authorType\" : \"System\",\n \"identifier\" : \"system\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/mesheventlogs/a4eba1b1-d635-4fc5-b3f6-c656373774f3\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
},
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshintegrations/{uuid}": {
"get": {
"tags": [
"Integrations"
],
"summary": "Get a built-in integration (Metering)",
"description": "Retrieve detailed information about a integration by its UUID.\n\nThe response includes all integration configuration except for sensitive fields,\nwhich are masked with '' for security purposes.\n\nUsers can only retrieve integrations that belong to their workspace as well as built-in integrations (replicator and metering).\nPlatform administrators can retrieve any integration.\n\nTo get the built-in integrations, use the following UUIDs:\n- Replicator: c8f4e7d2-3b1a-4c9e-8d5f-6a2b7c8d9e0f\n- Metering: a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshIntegration-Get-",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID that uniquely identifies the integration.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshintegration.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshintegration.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshIntegration-Get-builtin-metering"
},
"examples": {
"meshIntegration-Get-builtin-metering": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\",\n \"ownedByWorkspace\" : \"admin-customer\"\n },\n \"spec\" : {\n \"displayName\" : \"meshStack Metering (Built-in)\",\n \"config\" : {\n \"type\" : \"metering\"\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:04:35Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : true,\n \"workloadIdentityFederation\" : {\n \"issuer\" : \"https://container.googleapis.com/v1/projects/meshcloud-meshcloud--bc0/locations/europe-west1/clusters/meshstacks-ha\",\n \"subject\" : \"system:serviceaccount:meshcloud-dev:kraken-worker\",\n \"gcp\" : {\n \"audience\" : \"gcp-workload-identity-provider:meshcloud-dev\"\n },\n \"aws\" : {\n \"audience\" : \"aws-workload-identity-provider:meshcloud-dev\",\n \"thumbprint\" : \"08745487e891c19e3078c1f2a07e452950ef36f6\"\n },\n \"azure\" : {\n \"audience\" : \"api://AzureADTokenExchange\"\n }\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d\"\n }\n }\n}"
},
"meshIntegration-Get-gitlab": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"6125e767-d378-4b7f-8a3c-a1ea4676470b\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My GitLab Integration\",\n \"config\" : {\n \"type\" : \"gitlab\",\n \"gitlab\" : {\n \"baseUrl\" : \"https://gitlab.com\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.088175496Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/6125e767-d378-4b7f-8a3c-a1ea4676470b\"\n }\n }\n}"
},
"meshIntegration-Get-entra_id": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"4da7cb74-4291-483a-9407-7b047b172076\",\n \"ownedByWorkspace\" : \"demo-partner\"\n },\n \"spec\" : {\n \"displayName\" : \"My Entra ID Integration\",\n \"config\" : {\n \"type\" : \"entraid\",\n \"entraid\" : {\n \"tenantId\" : \"test-tenant-id\",\n \"clientId\" : \"test-client-id\",\n \"clientSecret\" : {\n \"hash\" : \"sha256:43a620a568e4f42f75cae5cbd74335924efc51874ba5cb765834571a7816da21\"\n },\n \"redirectUrl\" : \"http://localhost:5050/auth/realms/meshfed/broker/idp-integration-4da7cb74-4291-483a-9407-7b047b172076/endpoint\"\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.438048576Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/4da7cb74-4291-483a-9407-7b047b172076\"\n }\n }\n}"
},
"meshIntegration-Get-azure_devops": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"fe419510-0160-4a41-8a52-3a39a7deacd0\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My Azure DevOps Integration\",\n \"config\" : {\n \"type\" : \"azuredevops\",\n \"azuredevops\" : {\n \"baseUrl\" : \"https://dev.azure.com\",\n \"organization\" : \"my-org\",\n \"personalAccessToken\" : {\n \"hash\" : \"sha256:bce51f31dfa49b76a306a7bac2b0295a8d1575db3c5e4c1e3ae6d575d8c6f50d\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.262998971Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/fe419510-0160-4a41-8a52-3a39a7deacd0\"\n }\n }\n}"
},
"meshIntegration-Get-builtin-replicator": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"c8f4e7d2-3b1a-4c9e-8d5f-6a2b7c8d9e0f\",\n \"ownedByWorkspace\" : \"admin-customer\"\n },\n \"spec\" : {\n \"displayName\" : \"meshStack Replicator (Built-in)\",\n \"config\" : {\n \"type\" : \"replicator\"\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:04:35Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : true,\n \"workloadIdentityFederation\" : {\n \"issuer\" : \"https://container.googleapis.com/v1/projects/meshcloud-meshcloud--bc0/locations/europe-west1/clusters/meshstacks-ha\",\n \"subject\" : \"system:serviceaccount:meshcloud-dev:replicator\",\n \"gcp\" : {\n \"audience\" : \"gcp-workload-identity-provider:meshcloud-dev\"\n },\n \"aws\" : {\n \"audience\" : \"aws-workload-identity-provider:meshcloud-dev\",\n \"thumbprint\" : \"08745487e891c19e3078c1f2a07e452950ef36f6\"\n },\n \"azure\" : {\n \"audience\" : \"api://AzureADTokenExchange\"\n }\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/c8f4e7d2-3b1a-4c9e-8d5f-6a2b7c8d9e0f\"\n }\n }\n}"
},
"meshIntegration-Get-github": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My GitHub Integration\",\n \"config\" : {\n \"type\" : \"github\",\n \"github\" : {\n \"owner\" : \"my-org\",\n \"baseUrl\" : \"https://api.github.com\",\n \"appId\" : \"123456\",\n \"appPrivateKey\" : {\n \"hash\" : \"sha256:1e179003f0dee1c9ebbacbb338a9bff5955deefa173d81098ee7538d9caacb1f\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:17.906538732Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Integrations"
],
"summary": "Update an integration",
"description": "Update an existing integration.\n\nYou can update the integration display name, configuration, and runner association.\nThe integration type cannot be changed after creation.\n\nFor sensitive fields (appPrivateKey, personalAccessToken), you can either:\n- Provide a new value in the 'plaintext' property to update the secret\n- Provide the 'hash' property from a previous GET response to keep the existing value unchanged\n\nUsers can only update integrations that belong to their workspace unless they have admin permissions.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshIntegration-Put-",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID that uniquely identifies the integration to update.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshintegration.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshintegration.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshintegration.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshintegrations-uuid795364056"
},
"examples": {
"meshIntegration-Put-github": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"uuid\": \"d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"Updated GitHub Integration\",\n \"config\": {\n \"type\": \"github\",\n \"github\": {\n \"owner\": \"my-org\",\n \"baseUrl\": \"https://api.github.com\",\n \"appId\": \"123456\",\n \"appPrivateKey\": {\n \"plaintext\": \"test-private-key\"\n },\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\"\n }\n }\n }\n }\n}"
},
"meshIntegration-Put-entra_id": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"uuid\": \"4da7cb74-4291-483a-9407-7b047b172076\",\n \"ownedByWorkspace\": \"demo-partner\"\n },\n \"spec\": {\n \"displayName\": \"My Entra ID Integration\",\n \"config\": {\n \"type\": \"entraid\",\n \"entraid\": {\n \"tenantId\": \"test-tenant-id\",\n \"clientId\": \"test-client-id\",\n \"clientSecret\": {\n \"plaintext\": \"test-secret\"\n }\n }\n }\n }\n}"
},
"meshIntegration-Put-gitlab": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"uuid\": \"6125e767-d378-4b7f-8a3c-a1ea4676470b\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"Updated GitLab Integration\",\n \"config\": {\n \"type\": \"gitlab\",\n \"gitlab\": {\n \"baseUrl\": \"https://gitlab.com\",\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\"\n }\n }\n }\n }\n}"
},
"meshIntegration-Put-azure_devops": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshIntegration\",\n \"metadata\": {\n \"uuid\": \"fe419510-0160-4a41-8a52-3a39a7deacd0\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"Updated Azure DevOps Integration\",\n \"config\": {\n \"type\": \"azuredevops\",\n \"azuredevops\": {\n \"baseUrl\": \"https://dev.azure.com\",\n \"organization\": \"my-org\",\n \"personalAccessToken\": {\n \"plaintext\": \"test-pat-token\"\n },\n \"runnerRef\": {\n \"kind\": \"meshBuildingBlockRunner\",\n \"uuid\": \"05cfa85f-2818-4bdd-b193-620e0187d7de\"\n }\n }\n }\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshintegration.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshIntegration-Put-github"
},
"examples": {
"meshIntegration-Put-github": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated GitHub Integration\",\n \"config\" : {\n \"type\" : \"github\",\n \"github\" : {\n \"owner\" : \"my-org\",\n \"baseUrl\" : \"https://api.github.com\",\n \"appId\" : \"123456\",\n \"appPrivateKey\" : {\n \"hash\" : \"sha256:72c481b6486fb2f34dbb565b40a81de514ce189f2d33dbf85b489aac83cccc3c\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"dc8c57a1-823f-4e96-8582-0275fa27dc7b\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:17.906538732Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/d6a6bfa4-b3b4-4a9c-aebb-645b4bd5c045\"\n }\n }\n}"
},
"meshIntegration-Put-entra_id": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"4da7cb74-4291-483a-9407-7b047b172076\",\n \"ownedByWorkspace\" : \"demo-partner\"\n },\n \"spec\" : {\n \"displayName\" : \"My Entra ID Integration\",\n \"config\" : {\n \"type\" : \"entraid\",\n \"entraid\" : {\n \"tenantId\" : \"test-tenant-id\",\n \"clientId\" : \"test-client-id\",\n \"clientSecret\" : {\n \"hash\" : \"sha256:7fb9ff92380dffd9ebbf7257068a2283c0c969b2073feb474ede9c7dee0fb870\"\n },\n \"redirectUrl\" : \"http://localhost:5050/auth/realms/meshfed/broker/idp-integration-4da7cb74-4291-483a-9407-7b047b172076/endpoint\"\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.438048576Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/4da7cb74-4291-483a-9407-7b047b172076\"\n }\n }\n}"
},
"meshIntegration-Put-gitlab": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"6125e767-d378-4b7f-8a3c-a1ea4676470b\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated GitLab Integration\",\n \"config\" : {\n \"type\" : \"gitlab\",\n \"gitlab\" : {\n \"baseUrl\" : \"https://gitlab.com\",\n \"runnerRef\" : {\n \"uuid\" : \"f4f4402b-f54d-4ab9-93ae-c07e997041e9\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.088175496Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/6125e767-d378-4b7f-8a3c-a1ea4676470b\"\n }\n }\n}"
},
"meshIntegration-Put-azure_devops": {
"value": "{\n \"kind\" : \"meshIntegration\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"fe419510-0160-4a41-8a52-3a39a7deacd0\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated Azure DevOps Integration\",\n \"config\" : {\n \"type\" : \"azuredevops\",\n \"azuredevops\" : {\n \"baseUrl\" : \"https://dev.azure.com\",\n \"organization\" : \"my-org\",\n \"personalAccessToken\" : {\n \"hash\" : \"sha256:ad92afdc1de3347ffaa0325cae5769e3f723c0182f0f49f5cef183aa42c27d6d\"\n },\n \"runnerRef\" : {\n \"uuid\" : \"05cfa85f-2818-4bdd-b193-620e0187d7de\",\n \"kind\" : \"meshBuildingBlockRunner\"\n }\n }\n }\n },\n \"status\" : {\n \"lifecycle\" : {\n \"createdOn\" : \"2026-06-03T14:05:18.262998971Z\",\n \"state\" : \"ACTIVE\"\n },\n \"isBuiltIn\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshintegrations/fe419510-0160-4a41-8a52-3a39a7deacd0\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Integrations"
],
"summary": "Delete integration",
"description": "Delete a specific integration by its UUID.\n\nThis permanently removes the integration and its configuration.\nAn integration cannot be deleted if it is used in any building block definition version.\n\nUsers can only delete integrations that belong to their workspace unless they have admin permissions.\n\nReturns 204 No Content on successful deletion.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshIntegration-Delete",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID that uniquely identifies the integration to delete.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshintegration.v1.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshlandingzones/{identifier}": {
"get": {
"tags": [
"Landing Zones"
],
"summary": "Get landing zone",
"description": "Get a specific meshLandingZone by its identifier.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLandingZone-Get-",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The identifier of the meshLandingZone to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlandingzone.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshlandingzone.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLandingZone-Get-openshift"
},
"examples": {
"meshLandingZone-Get-openshift": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-openshift\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated openshift landing zone description\",\n \"displayName\" : \"Updated Landing Zone openshift\",\n \"platformRef\" : {\n \"uuid\" : \"1f1d4e84-d0ca-4d85-9e30-1f54849824bd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"openshift\",\n \"openshift\" : { }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-openshift\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/1f1d4e84-d0ca-4d85-9e30-1f54849824bd\"\n }\n }\n}"
},
"meshLandingZone-Get-aws": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aws\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated aws landing zone description\",\n \"displayName\" : \"Updated Landing Zone aws\",\n \"platformRef\" : {\n \"uuid\" : \"23ffc575-4670-4379-879a-25effbea544b\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"awsTargetOrgUnitId\" : \"ou-lpzq-kmf17bec\",\n \"awsEnrollAccount\" : true,\n \"awsLambdaArn\" : \"arn:aws:lambda:us-east-1:123456789012:function:MyLambdaFunction\",\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRole\" : \"AwsSpecificRole\",\n \"policies\" : [ \"arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aws\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/23ffc575-4670-4379-879a-25effbea544b\"\n }\n }\n}"
},
"meshLandingZone-Get-aks": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aks\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated aks landing zone description\",\n \"displayName\" : \"Updated Landing Zone aks\",\n \"platformRef\" : {\n \"uuid\" : \"a32a9277-f6d3-4a09-9083-5ca8d43831c9\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aks\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/a32a9277-f6d3-4a09-9083-5ca8d43831c9\"\n }\n }\n}"
},
"meshLandingZone-Get-custom": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-custom\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated custom landing zone description\",\n \"displayName\" : \"Updated Landing Zone custom\",\n \"platformRef\" : {\n \"uuid\" : \"5c4082eb-84d2-48d5-9804-ba3f8e2fd563\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"custom\",\n \"custom\" : { }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-custom\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c4082eb-84d2-48d5-9804-ba3f8e2fd563\"\n }\n }\n}"
},
"meshLandingZone-Get-azure": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azure\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated azure landing zone description\",\n \"displayName\" : \"Updated Landing Zone azure\",\n \"platformRef\" : {\n \"uuid\" : \"5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"azureManagementGroupId\" : \"azure-management-group\",\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"8c91d80b-141a-444a-b51c-4217c7384250\"\n },\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"admin\",\n \"azureRoleDefinitions\" : [ {\n \"azureRoleDefinitionId\" : \"c5935d7e-37b2-4f34-af8f-bdca2408296e\"\n } ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azure\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\"\n }\n }\n}"
},
"meshLandingZone-Get-gcp": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-gcp\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated gcp landing zone description\",\n \"displayName\" : \"Updated Landing Zone gcp\",\n \"platformRef\" : {\n \"uuid\" : \"8de142b8-8626-4eef-83a0-e99acf05fad2\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"gcpFolderId\" : \"12345\",\n \"gcpTemplateUrl\" : \"gs://my-bucket-name/folder/template\",\n \"gcpCloudFunctionUrl\" : \"https://us-central1-my-sample-project.cloudfunctions.net/helloWorld\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/owner\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\", \"roles/viewer\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-gcp\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/8de142b8-8626-4eef-83a0-e99acf05fad2\"\n }\n }\n}"
},
"meshLandingZone-Get-azurerg": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azurerg\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated azurerg landing zone description\",\n \"displayName\" : \"Updated Landing Zone azurerg\",\n \"platformRef\" : {\n \"uuid\" : \"e659bb60-3764-46b3-a4a2-5d82fcd1792d\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"azureRgLocation\" : \"eastus2\",\n \"azureRgRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"owner\",\n \"azureRoleDefinitionIds\" : [ \"fd876abe-603d-44d2-bf8a-067bbeacd485\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"reader\",\n \"azureRoleDefinitionIds\" : [ \"39a5f86f-a2d0-459d-b4eb-f536464933d0\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"user\",\n \"azureRoleDefinitionIds\" : [ \"492334bd-d0fd-4724-9270-e55495c2d88e\" ]\n } ],\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"78f9140e-1f7c-45a1-a633-3f1b92df362bn\"\n }\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azurerg\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/e659bb60-3764-46b3-a4a2-5d82fcd1792d\"\n }\n }\n}"
},
"meshLandingZone-Get-kubernetes": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-kubernetes\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated kubernetes landing zone description\",\n \"displayName\" : \"Updated Landing Zone kubernetes\",\n \"platformRef\" : {\n \"uuid\" : \"707ec5a2-426f-4087-8b37-2c67f10abddd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-kubernetes\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/707ec5a2-426f-4087-8b37-2c67f10abddd\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Landing Zones"
],
"summary": "Update landing zone",
"description": "Update an existing meshLandingZone. If a landing zone with the given identifier exists,\nit will be updated, otherwise, a new landing zone will be created.\n\nPlease note that changing the platform reference(`spec.platformRef`) is not supported.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLandingZone-Put-",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The landing zone identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlandingzone.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlandingzone.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshlandingzone.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshlandingzones-879138272"
},
"examples": {
"meshLandingZone-Put-aws": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aws\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone aws\",\n \"description\" : \"An updated aws landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"23ffc575-4670-4379-879a-25effbea544b\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"awsTargetOrgUnitId\" : \"ou-lpzq-kmf17bec\",\n \"awsEnrollAccount\" : true,\n \"awsLambdaArn\" : \"arn:aws:lambda:us-east-1:123456789012:function:MyLambdaFunction\",\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRole\" : \"AwsSpecificRole\",\n \"policies\" : [ \"arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Put-azurerg": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azurerg\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone azurerg\",\n \"description\" : \"An updated azurerg landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"e659bb60-3764-46b3-a4a2-5d82fcd1792d\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"azureRgLocation\" : \"eastus2\",\n \"azureRgRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"owner\",\n \"azureRoleDefinitionIds\" : [ \"fd876abe-603d-44d2-bf8a-067bbeacd485\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"reader\",\n \"azureRoleDefinitionIds\" : [ \"39a5f86f-a2d0-459d-b4eb-f536464933d0\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"user\",\n \"azureRoleDefinitionIds\" : [ \"492334bd-d0fd-4724-9270-e55495c2d88e\" ]\n } ],\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"78f9140e-1f7c-45a1-a633-3f1b92df362bn\"\n }\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Put-custom": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-custom\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone custom\",\n \"description\" : \"An updated custom landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"5c4082eb-84d2-48d5-9804-ba3f8e2fd563\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"custom\",\n \"custom\" : { }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Put-azure": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azure\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone azure\",\n \"description\" : \"An updated azure landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"azureManagementGroupId\" : \"azure-management-group\",\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"8c91d80b-141a-444a-b51c-4217c7384250\"\n },\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"admin\",\n \"azureRoleDefinitions\" : [ {\n \"azureRoleDefinitionId\" : \"c5935d7e-37b2-4f34-af8f-bdca2408296e\",\n \"abacCondition\" : null\n } ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Put-gcp": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-gcp\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone gcp\",\n \"description\" : \"An updated gcp landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"8de142b8-8626-4eef-83a0-e99acf05fad2\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"gcpFolderId\" : \"12345\",\n \"gcpTemplateUrl\" : \"gs://my-bucket-name/folder/template\",\n \"gcpCloudFunctionUrl\" : \"https://us-central1-my-sample-project.cloudfunctions.net/helloWorld\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/owner\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\", \"roles/viewer\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ ]\n }\n}"
},
"meshLandingZone-Put-aks": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aks\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone aks\",\n \"description\" : \"An updated aks landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"a32a9277-f6d3-4a09-9083-5ca8d43831c9\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n } ]\n }\n}"
},
"meshLandingZone-Put-openshift": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-openshift\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone openshift\",\n \"description\" : \"An updated openshift landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"1f1d4e84-d0ca-4d85-9e30-1f54849824bd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"openshift\",\n \"openshift\" : { }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n } ]\n }\n}"
},
"meshLandingZone-Put-kubernetes": {
"value": "{\n \"apiVersion\" : \"v1\",\n \"kind\" : \"meshLandingZone\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-kubernetes\",\n \"ownedByWorkspace\" : \"platform-team\",\n \"tags\" : { }\n },\n \"spec\" : {\n \"displayName\" : \"Updated Landing Zone kubernetes\",\n \"description\" : \"An updated kubernetes landing zone description\",\n \"platformRef\" : {\n \"uuid\" : \"707ec5a2-426f-4087-8b37-2c67f10abddd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n } ]\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshlandingzone.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLandingZone-Put-aws"
},
"examples": {
"meshLandingZone-Put-aws": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aws\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated aws landing zone description\",\n \"displayName\" : \"Updated Landing Zone aws\",\n \"platformRef\" : {\n \"uuid\" : \"23ffc575-4670-4379-879a-25effbea544b\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"awsTargetOrgUnitId\" : \"ou-lpzq-kmf17bec\",\n \"awsEnrollAccount\" : true,\n \"awsLambdaArn\" : \"arn:aws:lambda:us-east-1:123456789012:function:MyLambdaFunction\",\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRole\" : \"AwsSpecificRole\",\n \"policies\" : [ \"arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aws\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/23ffc575-4670-4379-879a-25effbea544b\"\n }\n }\n}"
},
"meshLandingZone-Put-azurerg": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azurerg\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated azurerg landing zone description\",\n \"displayName\" : \"Updated Landing Zone azurerg\",\n \"platformRef\" : {\n \"uuid\" : \"e659bb60-3764-46b3-a4a2-5d82fcd1792d\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"azureRgLocation\" : \"eastus2\",\n \"azureRgRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"owner\",\n \"azureRoleDefinitionIds\" : [ \"fd876abe-603d-44d2-bf8a-067bbeacd485\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"reader\",\n \"azureRoleDefinitionIds\" : [ \"39a5f86f-a2d0-459d-b4eb-f536464933d0\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"user\",\n \"azureRoleDefinitionIds\" : [ \"492334bd-d0fd-4724-9270-e55495c2d88e\" ]\n } ],\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"78f9140e-1f7c-45a1-a633-3f1b92df362bn\"\n }\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azurerg\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/e659bb60-3764-46b3-a4a2-5d82fcd1792d\"\n }\n }\n}"
},
"meshLandingZone-Put-custom": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-custom\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated custom landing zone description\",\n \"displayName\" : \"Updated Landing Zone custom\",\n \"platformRef\" : {\n \"uuid\" : \"5c4082eb-84d2-48d5-9804-ba3f8e2fd563\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"custom\",\n \"custom\" : { }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-custom\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c4082eb-84d2-48d5-9804-ba3f8e2fd563\"\n }\n }\n}"
},
"meshLandingZone-Put-azure": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-azure\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated azure landing zone description\",\n \"displayName\" : \"Updated Landing Zone azure\",\n \"platformRef\" : {\n \"uuid\" : \"5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"azureManagementGroupId\" : \"azure-management-group\",\n \"azureFunction\" : {\n \"azureFunctionUrl\" : \"https://my-function-app.azurewebsites.net/myfunc\",\n \"azureFunctionScope\" : \"8c91d80b-141a-444a-b51c-4217c7384250\"\n },\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureGroupSuffix\" : \"admin\",\n \"azureRoleDefinitions\" : [ {\n \"azureRoleDefinitionId\" : \"c5935d7e-37b2-4f34-af8f-bdca2408296e\"\n } ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-azure\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/5c7cdd40-61cc-4c30-99bd-bb5aee5926d7\"\n }\n }\n}"
},
"meshLandingZone-Put-gcp": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-gcp\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated gcp landing zone description\",\n \"displayName\" : \"Updated Landing Zone gcp\",\n \"platformRef\" : {\n \"uuid\" : \"8de142b8-8626-4eef-83a0-e99acf05fad2\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"gcpFolderId\" : \"12345\",\n \"gcpTemplateUrl\" : \"gs://my-bucket-name/folder/template\",\n \"gcpCloudFunctionUrl\" : \"https://us-central1-my-sample-project.cloudfunctions.net/helloWorld\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/owner\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"user\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"roles/editor\", \"roles/viewer\" ]\n } ]\n }\n },\n \"quotas\" : [ ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-gcp\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/8de142b8-8626-4eef-83a0-e99acf05fad2\"\n }\n }\n}"
},
"meshLandingZone-Put-aks": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-aks\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated aks landing zone description\",\n \"displayName\" : \"Updated Landing Zone aks\",\n \"platformRef\" : {\n \"uuid\" : \"a32a9277-f6d3-4a09-9083-5ca8d43831c9\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-aks\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/a32a9277-f6d3-4a09-9083-5ca8d43831c9\"\n }\n }\n}"
},
"meshLandingZone-Put-openshift": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-openshift\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated openshift landing zone description\",\n \"displayName\" : \"Updated Landing Zone openshift\",\n \"platformRef\" : {\n \"uuid\" : \"1f1d4e84-d0ca-4d85-9e30-1f54849824bd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"openshift\",\n \"openshift\" : { }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-openshift\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/1f1d4e84-d0ca-4d85-9e30-1f54849824bd\"\n }\n }\n}"
},
"meshLandingZone-Put-kubernetes": {
"value": "{\n \"kind\" : \"meshLandingZone\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"new-landing-zone-kubernetes\",\n \"tags\" : { },\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"description\" : \"An updated kubernetes landing zone description\",\n \"displayName\" : \"Updated Landing Zone kubernetes\",\n \"platformRef\" : {\n \"uuid\" : \"707ec5a2-426f-4087-8b37-2c67f10abddd\",\n \"kind\" : \"meshPlatform\"\n },\n \"automateDeletionApproval\" : true,\n \"automateDeletionReplication\" : true,\n \"infoLink\" : \"https://example.com/updated-info\",\n \"platformProperties\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"kubernetesRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"platformRoles\" : [ \"kubernetes-platform-role\" ]\n } ]\n }\n },\n \"quotas\" : [ {\n \"key\" : \"requests.cpu\",\n \"value\" : 8\n }, {\n \"key\" : \"limits.cpu\",\n \"value\" : 16\n }, {\n \"key\" : \"requests.memory\",\n \"value\" : 16\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 32\n }, {\n \"key\" : \"persistentvolumeclaims\",\n \"value\" : 10\n }, {\n \"key\" : \"requests.storage\",\n \"value\" : 100\n } ],\n \"mandatoryBuildingBlockRefs\" : [ {\n \"uuid\" : \"mandatory-compliance-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ],\n \"recommendedBuildingBlockRefs\" : [ {\n \"uuid\" : \"recommended-monitoring-bb-uuid\",\n \"kind\" : \"meshBuildingBlockDefinition\"\n } ]\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n },\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlandingzones/new-landing-zone-kubernetes\"\n },\n \"platformInstance\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/707ec5a2-426f-4087-8b37-2c67f10abddd\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Landing Zones"
],
"summary": "Delete landing zone",
"description": "Delete(disable) a specific meshLandingZone by identifier. Deleting a meshLandingZone will disable it,\npreventing new tenants from being created on this landing zone. Existing tenants will not be affected .\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLandingZone-Delete",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The landing zone identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlandingzone.v1.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshlocations/{identifier}": {
"get": {
"tags": [
"Locations"
],
"summary": "Get location",
"description": "Retrieve detailed information about a specific meshLocation\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLocation-Get",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The identifier that uniquely identifies the meshLocation.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlocation.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshlocation.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLocation-Get"
},
"examples": {
"meshLocation-Get": {
"value": "{\n \"kind\" : \"meshLocation\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"7db99cbb-6663-4ff8-b214-b405447a591c\",\n \"name\" : \"my-location\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"My Location\",\n \"description\" : \"My great location\"\n },\n \"status\" : {\n \"isPublic\" : true,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:25.860196334Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlocations/my-location\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Locations"
],
"summary": "Update location",
"description": "Update an existing meshLocation. This endpoint requires save permissions for platforms (there is no dedicated permission for locations as platforms and locations are closely related).\n\nYou can update the display name and description of a location. The identifier cannot be changed.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshLocation-Put",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The identifier that uniquely identifies the meshLocation.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlocation.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshlocation.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshlocation.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshlocations-1689823740"
},
"examples": {
"meshLocation-Put": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshLocation\",\n \"metadata\": {\n \"name\": \"my-location\",\n \"ownedByWorkspace\": \"platform-team\"\n },\n \"spec\": {\n \"displayName\": \"Updated Location Name\",\n \"description\": \"An updated description\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshlocation.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshLocation-Put"
},
"examples": {
"meshLocation-Put": {
"value": "{\n \"kind\" : \"meshLocation\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"7db99cbb-6663-4ff8-b214-b405447a591c\",\n \"name\" : \"my-location\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated Location Name\",\n \"description\" : \"An updated description\"\n },\n \"status\" : {\n \"isPublic\" : true,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:25.860196334Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshlocations/my-location\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshpaymentmethods/{identifier}": {
"put": {
"tags": [
"Payment Methods"
],
"summary": "Update payment method",
"description": "Update an existing meshPaymentMethod by identifier. This endpoint supports both updating an existing\npayment method as well as creating a new payment method if a payment method with this identifier does\nnot exist yet.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPaymentMethodV2Put",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The payment method identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectroles486549215"
},
"examples": {
"meshPaymentMethodV2Put": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPaymentMethod\",\n \"metadata\": {\n \"name\": \"test-payment-method-1\",\n \"ownedByWorkspace\": \"payment-workspace\"\n },\n \"spec\": {\n \"displayName\": \"Updated Payment Method\",\n \"amount\": 1500.00,\n \"expirationDate\": \"2026-01-31\",\n \"tags\": {}\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPaymentMethodV2Put"
},
"examples": {
"meshPaymentMethodV2Put": {
"value": "{\n \"kind\" : \"meshPaymentMethod\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-payment-method-1\",\n \"ownedByWorkspace\" : \"payment-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated Payment Method\",\n \"tags\" : { },\n \"amount\" : 1500,\n \"expirationDate\" : \"2026-01-31\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment-method-1\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?paymentIdentifier=test-payment-method-1\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Payment Methods"
],
"summary": "Delete payment method",
"description": "Delete a specific meshPaymentMethod by identifier. meshStack currently only allows soft deletion of payment methods.\n\nPlease note that it is possible to retrieve a payment method via the GET meshPaymentMethod endpoint after deletion.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPaymentMethodV2Delete",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The payment method identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshpaymentmethods/{paymentMethodIdentifier}": {
"get": {
"tags": [
"Payment Methods"
],
"summary": "Get payment method",
"description": "Get a specific meshPaymentMethod by its identifier. Deleted meshPaymentMethods can also be requested\nvia this endpoint. A future version of the meshPaymentMethod object will include additional fields to\nindicate the deletion state of a payment method.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPaymentMethodV2",
"parameters": [
{
"name": "paymentMethodIdentifier",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshpaymentmethod.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPaymentMethodV2"
},
"examples": {
"meshPaymentMethodV2": {
"value": "{\n \"kind\" : \"meshPaymentMethod\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-payment-method-1\",\n \"ownedByWorkspace\" : \"payment-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"Test Payment Method 1\",\n \"tags\" : { },\n \"amount\" : 1000\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment-method-1\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?paymentIdentifier=test-payment-method-1\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshplatforms/{uuid}": {
"get": {
"tags": [
"Platforms"
],
"summary": "Get platform",
"description": "Get a platform. The examples show the complete response including all configuration options for a given platform type.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatform-Get-V",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID of the meshPlatform.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatform.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshplatform.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-Get-V1-openshift"
},
"examples": {
"meshPlatform-Get-V1-openshift": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"openshift-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"1a7ee47e-1f55-4e31-b83f-9f17ca347b89\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-openshift\",\n \"description\" : \"test-platform-openshift\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"mesh/hidden-secret\"\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"roleMappings\" : {\n \"admin\" : \"admin\",\n \"member\" : \"edit\",\n \"reader\" : \"view\"\n },\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/1a7ee47e-1f55-4e31-b83f-9f17ca347b89\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V1-kubernetes": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"kubernetes-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"64b5a735-1dc3-4208-a0c6-e16d9d5949d4\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-kubernetes\",\n \"description\" : \"test-platform-kubernetes\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"mesh/hidden-secret\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/64b5a735-1dc3-4208-a0c6-e16d9d5949d4\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V1-azurerg": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg\",\n \"description\" : \"test-platform-azurerg\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V1-aks": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks\",\n \"description\" : \"test-platform-aks\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : \"mesh/hidden-secret\",\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"administrativeUnitId\" : \"12345678-1234-1234-1234-123456789012\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V1-aws": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws\",\n \"description\" : \"test-platform-aws\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"serviceUserConfig\" : {\n \"accessKey\" : \"*****\",\n \"secretKey\" : \"mesh/hidden-secret\"\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : \"mesh/hidden-secret\",\n \"roleMappings\" : {\n \"admin\" : {\n \"awsRoleName\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n },\n \"member\" : {\n \"awsRoleName\" : \"MemberRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n }\n },\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V1-gcp": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp\",\n \"description\" : \"test-platform-gcp\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccountConfig\" : {\n \"serviceAccountCredentialsConfig\" : {\n \"serviceAccountCredentialsB64\" : \"mesh/hidden-secret\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"roleMappings\" : {\n \"admin\" : \"roles/owner\",\n \"member\" : \"roles/editor\",\n \"reader\" : \"roles/viewer\"\n },\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V1-azure": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure\",\n \"description\" : \"test-platform-azure\",\n \"endpoint\" : \"\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\"\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"roleMappings\" : {\n \"admin\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n },\n \"member\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n },\n \"reader\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n },\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshplatform.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-Get-V2-azurerg"
},
"examples": {
"meshPlatform-Get-V2-azurerg": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg\",\n \"description\" : \"test-platform-azurerg\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:b6ec4478ddfdffe8426c8b378993c749576a4b3ec0148ac7c3a1eeb448380173\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V2-custom": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"custom-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-custom\",\n \"description\" : \"test-platform-custom\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"custom\",\n \"custom\" : {\n \"platformTypeRef\" : {\n \"name\" : \"my-custom-platform-type\",\n \"kind\" : \"meshPlatformType\"\n },\n \"metering\" : {\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V2-aws": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws\",\n \"description\" : \"test-platform-aws\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:59e61bb8773997c254d39d9842a51fa4314ad234ee30ad713ee7d1e917ca3d1f\"\n }\n }\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"accountNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : {\n \"hash\" : \"sha256:7ba7480d65686e536362a02dd0be0cb7840f04728d2660e68f5ef3124be4003a\"\n },\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"ReaderRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n } ],\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n },\n \"metering\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:a8a2a7399fb7de1e903a180ce476bc40244429a2d1d7f3c3d51b178ab0ca3694\"\n }\n }\n }\n },\n \"filter\" : \"NONE\",\n \"reservedInstanceFairChargeback\" : false,\n \"savingsPlanFairChargeback\" : false,\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V2-kubernetes": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"kubernetes-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-kubernetes\",\n \"description\" : \"test-platform-kubernetes\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:e430b770c608e9af8bf43394a0d166787aa3151d032fa5d4ccbdfcba716ab196\"\n }\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:5bcd36368452a3c7ef77443dc1fa4840adb032d1c963b94548c89b87fb3860b3\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores\",\n \"description\" : \"Maximum number of CPU cores\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 100,\n \"autoApprovalThreshold\" : 50\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory\",\n \"description\" : \"Maximum memory allocation\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 500,\n \"autoApprovalThreshold\" : 250\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V2-openshift": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"openshift-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-openshift\",\n \"description\" : \"test-platform-openshift\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:8eaed76413d1be1cd5327caf27eb0b0d71317d8fe5e59d18d51bad5e1b8ef2f0\"\n }\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"openshiftRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"admin\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"edit\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"view\"\n } ],\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:6b5de27e6f7878b190e27ddf534a9a9d197cc8e86a40a0eaf4f70b1057e91ac2\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores\",\n \"description\" : \"Maximum number of CPU cores\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 100,\n \"autoApprovalThreshold\" : 50\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory\",\n \"description\" : \"Maximum memory allocation\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 500,\n \"autoApprovalThreshold\" : 250\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V2-azure": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure\",\n \"description\" : \"test-platform-azure\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:cd88221a6c67fa850d9b99a3f3b1247d062875e0d99ab544d33b423697037dec\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:1dc8fea647050c0c27e6fad964b3c19a066fec44e49c9f5469c06370fc50280c\"\n }\n }\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"updateSubscriptionName\" : true,\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n } ],\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n },\n \"metering\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:aa18ffce72924b4f1fa98b48d486e05c70361e52a96e1a4033415898e9439464\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V2-aks": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks\",\n \"description\" : \"test-platform-aks\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:7a676636f3f7fed0195abbfbd313cf8f5fdf8f268731a7d7bafae2bc709e1c2d\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:02f84a1c8ca6a25f44f5a39a213a82d6a4beec551386d1ff2c7f4e4175015af9\"\n }\n },\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"UserByMailLookupStrategy\",\n \"administrativeUnitId\" : \"3f52c8c1-9d4e-4c1a-b6df-1ea2f6b8f927\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:e366a9440c504f6b9fd88da6c57efb585023e05037d62fd36b7b6d9868f45f93\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores\",\n \"description\" : \"Maximum number of CPU cores\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 100,\n \"autoApprovalThreshold\" : 50\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory\",\n \"description\" : \"Maximum memory allocation\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 500,\n \"autoApprovalThreshold\" : 250\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Get-V2-gcp": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp\",\n \"description\" : \"test-platform-gcp\",\n \"endpoint\" : \"https://example.com\",\n \"supportUrl\" : \"\",\n \"documentationUrl\" : \"\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:f3b44d3b9aa82c3da062065f546d7032a89237f34920330583fdae9d2f19454b\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/owner\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/editor\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/viewer\"\n } ],\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n },\n \"metering\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:fd4b628af60145189a5c9aab20da50f6eb57fd66dc8d16e5b9f09b7d0c8925c6\"\n }\n },\n \"bigqueryTable\" : \"project.dataset.table\",\n \"bigqueryTableForCarbonFootprint\" : \"project.dataset.carbon_table\",\n \"carbonFootprintDataCollectionStartMonth\" : \"2023-01\",\n \"partitionTimeColumn\" : \"export_time\",\n \"additionalFilter\" : \"project.id != 'excluded-project'\",\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Platforms"
],
"summary": "Update platform",
"description": "Update an existing platform. The examples show all available configuration options for a given platform type. Note: The platform type is set during creation and cannot be changed afterwards. Any attempt to change the platform type will result in an error.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatform-Put-V",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID of the meshPlatform.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatform.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatform.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshplatform.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshplatforms-uuid-1009187272"
},
"examples": {
"meshPlatform-Put-V2-kubernetes": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"438f774a-43c7-4315-a294-f48d1d1ebd8c\",\n \"name\": \"kubernetes-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-kubernetes-updated\",\n \"description\": \"test-platform-kubernetes-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [{\n \"quotaKey\": \"cpu\",\n \"label\": \"CPU Cores Updated\",\n \"description\": \"Maximum number of CPU cores (updated)\",\n \"unit\": \"cores\",\n \"minValue\": 1,\n \"maxValue\": 200,\n \"autoApprovalThreshold\": 75\n},\n{\n \"quotaKey\": \"memory\",\n \"label\": \"Memory Updated\",\n \"description\": \"Maximum memory allocation (updated)\",\n \"unit\": \"GB\",\n \"minValue\": 1,\n \"maxValue\": 1000,\n \"autoApprovalThreshold\": 500\n}],\n \"config\": {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V2-gcp": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"d2d6d321-f8ce-4f16-afb4-6233604606d7\",\n \"name\": \"gcp-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-gcp-updated\",\n \"description\": \"test-platform-gcp-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/owner\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/editor\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/viewer\"\n } ],\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n },\n \"metering\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"bigqueryTable\" : \"project.dataset.table\",\n \"bigqueryTableForCarbonFootprint\" : \"project.dataset.carbon_table\",\n \"carbonFootprintDataCollectionStartMonth\" : \"2023-01\",\n \"partitionTimeColumn\" : \"export_time\",\n \"additionalFilter\" : \"project.id != 'excluded-project'\",\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V2-aks": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"db248fd0-bff8-42f0-8d37-d0fdee61531a\",\n \"name\": \"aks-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aks-updated\",\n \"description\": \"test-platform-aks-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [{\n \"quotaKey\": \"cpu\",\n \"label\": \"CPU Cores Updated\",\n \"description\": \"Maximum number of CPU cores (updated)\",\n \"unit\": \"cores\",\n \"minValue\": 1,\n \"maxValue\": 200,\n \"autoApprovalThreshold\": 75\n},\n{\n \"quotaKey\": \"memory\",\n \"label\": \"Memory Updated\",\n \"description\": \"Maximum memory allocation (updated)\",\n \"unit\": \"GB\",\n \"minValue\": 1,\n \"maxValue\": 1000,\n \"autoApprovalThreshold\": 500\n}],\n \"config\": {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"UserByMailLookupStrategy\",\n \"administrativeUnitId\" : \"3f52c8c1-9d4e-4c1a-b6df-1ea2f6b8f927\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V2-azure": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"72d10b8a-eec5-4c95-a826-05d02874dd80\",\n \"name\": \"azure-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azure-updated\",\n \"description\": \"test-platform-azure-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n }\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"updateSubscriptionName\" : true,\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n } ],\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n },\n \"metering\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V2-openshift": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"faf44c1f-ce87-4fd2-99ca-608f1bfca875\",\n \"name\": \"openshift-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-openshift-updated\",\n \"description\": \"test-platform-openshift-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [{\n \"quotaKey\": \"cpu\",\n \"label\": \"CPU Cores Updated\",\n \"description\": \"Maximum number of CPU cores (updated)\",\n \"unit\": \"cores\",\n \"minValue\": 1,\n \"maxValue\": 200,\n \"autoApprovalThreshold\": 75\n},\n{\n \"quotaKey\": \"memory\",\n \"label\": \"Memory Updated\",\n \"description\": \"Maximum memory allocation (updated)\",\n \"unit\": \"GB\",\n \"minValue\": 1,\n \"maxValue\": 1000,\n \"autoApprovalThreshold\": 500\n}],\n \"config\": {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"openshiftRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"admin\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"edit\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"view\"\n } ],\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"plaintext\" : \"sample-access-token\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V2-azurerg": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"4234c49e-92f8-40a1-bc81-4943fb1d9772\",\n \"name\": \"azurerg-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azurerg-updated\",\n \"description\": \"test-platform-azurerg-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"plaintext\" : \"sample-secret\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V2-aws": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"79f0eee5-96ad-42f0-b842-c300879880e0\",\n \"name\": \"aws-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aws-updated\",\n \"description\": \"test-platform-aws-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"plaintext\" : \"sample-secret\"\n }\n }\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"accountNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : {\n \"plaintext\" : \"sso-access-token-value\"\n },\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"ReaderRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n } ],\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n },\n \"metering\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"plaintext\" : \"sample-secret\"\n }\n }\n }\n },\n \"filter\" : \"NONE\",\n \"reservedInstanceFairChargeback\" : false,\n \"savingsPlanFairChargeback\" : false,\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V2-custom": {
"value": " {\n \"apiVersion\": \"v2\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"c7218f06-a89d-42e0-899d-8d3ef0701729\",\n \"name\": \"custom-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-custom-updated\",\n \"description\": \"test-platform-custom-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"name\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"publicationState\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"quotaDefinitions\": [],\n \"config\": {\n \"type\" : \"custom\",\n \"custom\" : {\n \"platformTypeRef\" : {\n \"name\" : \"my-custom-platform-type\",\n \"kind\" : \"meshPlatformType\"\n },\n \"metering\" : {\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n}\n }\n }"
}
}
},
"application/vnd.meshcloud.api.meshplatform.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshplatforms-uuid-453116572"
},
"examples": {
"meshPlatform-Put-V1-aws": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"b3ba6ed4-4792-401c-a877-19d57bbe2f97\",\n \"name\": \"aws-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aws-updated\",\n \"description\": \"test-platform-aws-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"serviceUserConfig\" : {\n \"accessKey\" : \"*****\",\n \"secretKey\" : \"*****\"\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : \"sso-access-token-value\",\n \"roleMappings\" : {\n \"admin\" : {\n \"awsRoleName\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n },\n \"member\" : {\n \"awsRoleName\" : \"MemberRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n }\n },\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V1-openshift": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"1a7ee47e-1f55-4e31-b83f-9f17ca347b89\",\n \"name\": \"openshift-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-openshift-updated\",\n \"description\": \"test-platform-openshift-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"*****\"\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"roleMappings\" : {\n \"admin\" : \"admin\",\n \"member\" : \"edit\",\n \"reader\" : \"view\"\n },\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V1-kubernetes": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"64b5a735-1dc3-4208-a0c6-e16d9d5949d4\",\n \"name\": \"kubernetes-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-kubernetes-updated\",\n \"description\": \"test-platform-kubernetes-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"*****\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V1-azurerg": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"203cf6f6-ffe9-4568-a7c8-0789f490d336\",\n \"name\": \"azurerg-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azurerg-updated\",\n \"description\": \"test-platform-azurerg-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V1-gcp": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"02a853e9-c958-493b-9250-a34f1ff7db1b\",\n \"name\": \"gcp-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-gcp-updated\",\n \"description\": \"test-platform-gcp-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccountConfig\" : {\n \"serviceAccountCredentialsConfig\" : {\n \"serviceAccountCredentialsB64\" : \"*****\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"roleMappings\" : {\n \"admin\" : \"roles/owner\",\n \"member\" : \"roles/editor\",\n \"reader\" : \"roles/viewer\"\n },\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V1-azure": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\",\n \"name\": \"azure-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-azure-updated\",\n \"description\": \"test-platform-azure-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\"\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"roleMappings\" : {\n \"admin\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n },\n \"member\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n },\n \"reader\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n },\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n }\n }\n}\n }\n }"
},
"meshPlatform-Put-V1-aks": {
"value": " {\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatform\",\n \"metadata\": {\n \"uuid\": \"cac78b51-a8b1-4bab-a96a-27268a21514f\",\n \"name\": \"aks-dev\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"spec\": {\n \"displayName\": \"test-platform-aks-updated\",\n \"description\": \"test-platform-aks-updated\",\n \"endpoint\": \"https://updated.example.com\",\n \"supportUrl\": \"https://support.updated.example.com\",\n \"documentationUrl\": \"https://docs.updated.example.com\",\n \"locationRef\": {\n \"kind\": \"meshLocation\",\n \"identifier\": \"test-dev\"\n },\n \"contributingWorkspaces\": [],\n \"availability\": {\n \"restriction\": \"PRIVATE\",\n \"marketplaceStatus\": \"UNPUBLISHED\",\n \"restrictedToWorkspaces\": [\"test-workspace\"]\n },\n \"config\": {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : \"*****\",\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"*****\",\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"administrativeUnitId\" : \"12345678-1234-1234-1234-123456789012\"\n }\n }\n}\n }\n }"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshplatform.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-Put-V2-kubernetes"
},
"examples": {
"meshPlatform-Put-V2-kubernetes": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"kubernetes-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-kubernetes-updated\",\n \"description\" : \"test-platform-kubernetes-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:43f87c9214d556a6f5f8587ee90228046af51df331ef8e9642460d74c40c86f7\"\n }\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:89a31cddc33bd88ada13992c9cf746d5aa9024ce98aeae1427400bc0ac858595\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores Updated\",\n \"description\" : \"Maximum number of CPU cores (updated)\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 200,\n \"autoApprovalThreshold\" : 75\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory Updated\",\n \"description\" : \"Maximum memory allocation (updated)\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 1000,\n \"autoApprovalThreshold\" : 500\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/438f774a-43c7-4315-a294-f48d1d1ebd8c\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V2-gcp": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp-updated\",\n \"description\" : \"test-platform-gcp-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:ce4dde49bb254155882c920794a1e153cc1465b6eceb51562527957c09a23e15\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"gcpRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/owner\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/editor\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"gcpRole\" : \"roles/viewer\"\n } ],\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n },\n \"metering\" : {\n \"serviceAccount\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:31bceadca7bfff0ba9437c135488ce43c6fc58224591515e741e802abd7bac81\"\n }\n },\n \"bigqueryTable\" : \"project.dataset.table\",\n \"bigqueryTableForCarbonFootprint\" : \"project.dataset.carbon_table\",\n \"carbonFootprintDataCollectionStartMonth\" : \"2023-01\",\n \"partitionTimeColumn\" : \"export_time\",\n \"additionalFilter\" : \"project.id != 'excluded-project'\",\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/d2d6d321-f8ce-4f16-afb4-6233604606d7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V2-aks": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks-updated\",\n \"description\" : \"test-platform-aks-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:332e4dc99df352242856595f55f7dcbcd28b8181e4bf1826c66b6ecc5b8d0ffc\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:9ce9cafb613e39d35a53f58c7e360886a5bef899e6081d3113457b4fe39e3ed8\"\n }\n },\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"UserByMailLookupStrategy\",\n \"administrativeUnitId\" : \"3f52c8c1-9d4e-4c1a-b6df-1ea2f6b8f927\"\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:5b102d88fce1a04abe6ffa52afef8902654e8ec85ee594616cb416a4793f0178\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores Updated\",\n \"description\" : \"Maximum number of CPU cores (updated)\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 200,\n \"autoApprovalThreshold\" : 75\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory Updated\",\n \"description\" : \"Maximum memory allocation (updated)\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 1000,\n \"autoApprovalThreshold\" : 500\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/db248fd0-bff8-42f0-8d37-d0fdee61531a\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V2-azure": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure-updated\",\n \"description\" : \"test-platform-azure-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:1af7854464adfc1bd7eafcb4cc44ad02180c2ef89732169e205b058dd4ab4ee7\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:19da0f6b77d50986e79ad2a4dd0179444342d675ca6fd0cc534f92bde04829aa\"\n }\n }\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"updateSubscriptionName\" : true,\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"azureRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n }\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"azureRole\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n } ],\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n },\n \"metering\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:4eb3e9cb9c9cb3522684f049280c947e7213d4c22f9f16dc154bf134808216cf\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/72d10b8a-eec5-4c95-a826-05d02874dd80\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V2-openshift": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"openshift-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-openshift-updated\",\n \"description\" : \"test-platform-openshift-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:24675154c601e2b99c1296ae0d0aa36eec61045947574f3c4e61ca5e5c874235\"\n }\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"openshiftRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"admin\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"member\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"edit\"\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"openshiftRole\" : \"view\"\n } ],\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n },\n \"metering\" : {\n \"clientConfig\" : {\n \"accessToken\" : {\n \"hash\" : \"sha256:97869850209bdd7ebd63e1727465c680ba90a62fb8f3f3acf20d609b3d8e6400\"\n }\n },\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ {\n \"quotaKey\" : \"cpu\",\n \"label\" : \"CPU Cores Updated\",\n \"description\" : \"Maximum number of CPU cores (updated)\",\n \"unit\" : \"cores\",\n \"minValue\" : 1,\n \"maxValue\" : 200,\n \"autoApprovalThreshold\" : 75\n }, {\n \"quotaKey\" : \"memory\",\n \"label\" : \"Memory Updated\",\n \"description\" : \"Maximum memory allocation (updated)\",\n \"unit\" : \"GB\",\n \"minValue\" : 1,\n \"maxValue\" : 1000,\n \"autoApprovalThreshold\" : 500\n } ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/faf44c1f-ce87-4fd2-99ca-608f1bfca875\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V2-azurerg": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg-updated\",\n \"description\" : \"test-platform-azurerg-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"hash\" : \"sha256:0d10d4d4f1e5fb821c76f7f64882742eb2207c9a44678b0178cb32fa2aabec50\"\n }\n },\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/4234c49e-92f8-40a1-bc81-4943fb1d9772\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V2-aws": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws-updated\",\n \"description\" : \"test-platform-aws-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:451ba8e737d108df85efce60858480b605324f1d5ff0a01a155e04c65665ee94\"\n }\n }\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"accountNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : {\n \"hash\" : \"sha256:cc63c96418021bcaf7641c300b9f4d44c067197365f4b235e4ff8b463593a1d6\"\n },\n \"awsRoleMappings\" : [ {\n \"projectRoleRef\" : {\n \"name\" : \"admin\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n }, {\n \"projectRoleRef\" : {\n \"name\" : \"reader\",\n \"kind\" : \"meshProjectRole\"\n },\n \"awsRole\" : \"ReaderRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n } ],\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n },\n \"metering\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"auth\" : {\n \"type\" : \"credential\",\n \"credential\" : {\n \"accessKey\" : \"AKIAIOSFODNN7EXAMPLE\",\n \"secretKey\" : {\n \"hash\" : \"sha256:7436606196bf386c22e3ac2577fc9b60754138498315ab437d51d9ddc60cd769\"\n }\n }\n }\n },\n \"filter\" : \"NONE\",\n \"reservedInstanceFairChargeback\" : false,\n \"savingsPlanFairChargeback\" : false,\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/79f0eee5-96ad-42f0-b842-c300879880e0\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V2-custom": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"custom-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"name\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-custom-updated\",\n \"description\" : \"test-platform-custom-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"custom\",\n \"custom\" : {\n \"platformTypeRef\" : {\n \"name\" : \"my-custom-platform-type\",\n \"kind\" : \"meshPlatformType\"\n },\n \"metering\" : {\n \"processing\" : {\n \"compactTimelinesAfterDays\" : 30,\n \"deleteRawDataAfterDays\" : 65\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ],\n \"quotaDefinitions\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"PENDING\",\n \"availability\" : {\n \"publicationState\" : \"UNPUBLISHED\"\n },\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/c7218f06-a89d-42e0-899d-8d3ef0701729\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
}
}
},
"application/vnd.meshcloud.api.meshplatform.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatform-Put-V1-aws"
},
"examples": {
"meshPlatform-Put-V1-aws": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aws-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aws-updated\",\n \"description\" : \"test-platform-aws-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aws\",\n \"aws\" : {\n \"region\" : \"us-east-1\",\n \"replication\" : {\n \"accessConfig\" : {\n \"organizationRootAccountRole\" : \"OrganizationAccountAccessRole\",\n \"organizationRootAccountExternalId\" : \"external-id-12345\",\n \"serviceUserConfig\" : {\n \"accessKey\" : \"*****\",\n \"secretKey\" : \"mesh/hidden-secret\"\n }\n },\n \"waitForExternalAvm\" : true,\n \"automationAccountRole\" : \"meshstack-automation-role\",\n \"automationAccountExternalId\" : \"automation-external-id\",\n \"accountAccessRole\" : \"meshstack-account-access-role\",\n \"accountAliasPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"enforceAccountAlias\" : true,\n \"accountEmailPattern\" : \"aws+#{workspaceIdentifier}.#{projectIdentifier}.#{tenantPlatformNumber}@example.com\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"awsSso\" : {\n \"scimEndpoint\" : \"https://scim.us-east-1.amazonaws.com/12345678-1234-1234-1234-123456789012/scim/v2/\",\n \"arn\" : \"arn:aws:sso:::instance/ssoins-123456789012\",\n \"groupNamePattern\" : \"example.#{workspaceIdentifier}.#{projectIdentifier}.#{platformGroupAlias}\",\n \"ssoAccessToken\" : \"mesh/hidden-secret\",\n \"roleMappings\" : {\n \"admin\" : {\n \"awsRoleName\" : \"AdminRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-123456789012\" ]\n },\n \"member\" : {\n \"awsRoleName\" : \"MemberRole\",\n \"permissionSetArns\" : [ \"arn:aws:sso:::permissionSet/ssoins-123456789012/ps-098765432109\" ]\n }\n },\n \"signInUrl\" : \"https://d-123456789012.awsapps.com/start\"\n },\n \"enrollmentConfiguration\" : {\n \"managementAccountId\" : \"123456789012\",\n \"accountFactoryProductId\" : \"prod-123456789012\"\n },\n \"selfDowngradeAccessRole\" : false,\n \"skipUserGroupPermissionCleanup\" : false,\n \"allowHierarchicalOrganizationalUnitAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/b3ba6ed4-4792-401c-a877-19d57bbe2f97\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V1-openshift": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"openshift-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"1a7ee47e-1f55-4e31-b83f-9f17ca347b89\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-openshift-updated\",\n \"description\" : \"test-platform-openshift-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"openshift\",\n \"openshift\" : {\n \"baseUrl\" : \"https://api.openshift.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"mesh/hidden-secret\"\n },\n \"webConsoleUrl\" : \"https://console-openshift-console.apps.openshift.example.com\",\n \"projectNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"roleMappings\" : {\n \"admin\" : \"admin\",\n \"member\" : \"edit\",\n \"reader\" : \"view\"\n },\n \"identityProviderName\" : \"meshstack-ldap\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n }\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/1a7ee47e-1f55-4e31-b83f-9f17ca347b89\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V1-kubernetes": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"kubernetes-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"64b5a735-1dc3-4208-a0c6-e16d9d5949d4\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-kubernetes-updated\",\n \"description\" : \"test-platform-kubernetes-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"kubernetes\",\n \"kubernetes\" : {\n \"baseUrl\" : \"https://kubernetes.example.com:6443\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"clientConfig\" : {\n \"accessToken\" : \"mesh/hidden-secret\"\n },\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/64b5a735-1dc3-4208-a0c6-e16d9d5949d4\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V1-azurerg": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azurerg-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azurerg-updated\",\n \"description\" : \"test-platform-azurerg-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azurerg\",\n \"azurerg\" : {\n \"entraTenant\" : \"contoso.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"subscription\" : \"11111111-1111-1111-1111-111111111111\",\n \"resourceGroupNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}-rg\",\n \"userGroupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"22222222-2222-2222-2222-222222222222\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/203cf6f6-ffe9-4568-a7c8-0789f490d336\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V1-gcp": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"gcp-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-gcp-updated\",\n \"description\" : \"test-platform-gcp-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"gcp\",\n \"gcp\" : {\n \"replication\" : {\n \"serviceAccountConfig\" : {\n \"serviceAccountCredentialsConfig\" : {\n \"serviceAccountCredentialsB64\" : \"mesh/hidden-secret\"\n }\n },\n \"domain\" : \"example.com\",\n \"customerId\" : \"C01234567\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"projectNamePattern\" : \"#{workspaceIdentifier} - #{projectIdentifier}\",\n \"projectIdPattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"billingAccountId\" : \"012345-ABCDEF-GHIJKL\",\n \"userLookupStrategy\" : \"email\",\n \"roleMappings\" : {\n \"admin\" : \"roles/owner\",\n \"member\" : \"roles/editor\",\n \"reader\" : \"roles/viewer\"\n },\n \"allowHierarchicalFolderAssignment\" : true,\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"pident\",\n \"valuePattern\" : \"prefix-${projectIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"skipUserGroupPermissionCleanup\" : false\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/02a853e9-c958-493b-9250-a34f1ff7db1b\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V1-azure": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"azure-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-azure-updated\",\n \"description\" : \"test-platform-azure-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"azure\",\n \"azure\" : {\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"replication\" : {\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"provisioning\" : {\n \"subscriptionOwnerObjectIds\" : [ \"11111111-1111-1111-1111-111111111111\", \"22222222-2222-2222-2222-222222222222\" ],\n \"enterpriseEnrollment\" : {\n \"enrollmentAccountId\" : \"123456\",\n \"subscriptionOfferType\" : \"MS-AZR-0017P\",\n \"useLegacySubscriptionEnrollment\" : false,\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"customerAgreement\" : {\n \"sourceServicePrincipal\" : {\n \"clientId\" : \"33333333-3333-3333-3333-333333333333\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\"\n },\n \"destinationEntraId\" : \"44444444-4444-4444-4444-444444444444\",\n \"sourceEntraTenant\" : \"source.onmicrosoft.com\",\n \"billingScope\" : \"/billingAccounts/12345:67890/billingProfiles/ABCD-EFGH-1234/invoiceSections/IJKL-MNOP-5678\",\n \"subscriptionCreationErrorCooldownSec\" : 900\n },\n \"preProvisioned\" : {\n \"unusedSubscriptionNamePrefix\" : \"meshstack-unused\"\n }\n },\n \"b2bUserInvitation\" : {\n \"redirectUrl\" : \"https://meshstack.example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true\n },\n \"subscriptionNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"roleMappings\" : {\n \"admin\" : {\n \"alias\" : \"Owner\",\n \"id\" : \"8e3af657-a8ff-443c-a75c-2fe8c4bcb635\"\n },\n \"member\" : {\n \"alias\" : \"Contributor\",\n \"id\" : \"b24988ac-6180-42a0-ab88-20f7382dd24c\"\n },\n \"reader\" : {\n \"alias\" : \"Reader\",\n \"id\" : \"acdd72a7-3385-48ef-bd42-f606fba81ae7\"\n }\n },\n \"tenantTags\" : {\n \"namespacePrefix\" : \"meshstack_\",\n \"tagMappers\" : [ {\n \"key\" : \"wident\",\n \"valuePattern\" : \"prefix-${workspaceIdentifier}\"\n }, {\n \"key\" : \"environment\",\n \"valuePattern\" : \"production\"\n } ]\n },\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"skipUserGroupPermissionCleanup\" : false,\n \"administrativeUnitId\" : \"77777777-7777-7777-7777-777777777777\",\n \"allowHierarchicalManagementGroupAssignment\" : true\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/3d3ebf79-74ff-4231-b8b5-910ad8aee9c7\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
},
"meshPlatform-Put-V1-aks": {
"value": "{\n \"kind\" : \"meshPlatform\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"aks-dev\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"uuid\" : \"cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"spec\" : {\n \"locationRef\" : {\n \"identifier\" : \"test-dev\",\n \"kind\" : \"meshLocation\"\n },\n \"availability\" : {\n \"restriction\" : \"PRIVATE\",\n \"restrictedToWorkspaces\" : [ \"test-workspace\" ],\n \"marketplaceStatus\" : \"UNPUBLISHED\"\n },\n \"displayName\" : \"test-platform-aks-updated\",\n \"description\" : \"test-platform-aks-updated\",\n \"endpoint\" : \"https://updated.example.com\",\n \"supportUrl\" : \"https://support.updated.example.com\",\n \"documentationUrl\" : \"https://docs.updated.example.com\",\n \"config\" : {\n \"type\" : \"aks\",\n \"aks\" : {\n \"baseUrl\" : \"https://my-aks-cluster.region.azmk8s.io\",\n \"disableSslValidation\" : false,\n \"replication\" : {\n \"accessToken\" : \"mesh/hidden-secret\",\n \"namespaceNamePattern\" : \"#{workspaceIdentifier}-#{projectIdentifier}\",\n \"groupNamePattern\" : \"aks-#{workspaceIdentifier}.#{projectIdentifier}-#{platformGroupAlias}\",\n \"servicePrincipal\" : {\n \"clientId\" : \"12345678-1234-1234-1234-123456789012\",\n \"authType\" : \"CREDENTIALS\",\n \"credentialsAuthClientSecret\" : \"mesh/hidden-secret\",\n \"entraTenant\" : \"aadtenant.onmicrosoft.com\",\n \"objectId\" : \"87654321-4321-4321-4321-210987654321\"\n },\n \"aksSubscriptionId\" : \"12345678-1234-1234-1234-123456789012\",\n \"aksClusterName\" : \"aks\",\n \"aksResourceGroup\" : \"aks-resource-group\",\n \"redirectUrl\" : \"https://example.com/auth/callback\",\n \"sendAzureInvitationMail\" : true,\n \"userLookUpStrategy\" : \"userPrincipalName\",\n \"administrativeUnitId\" : \"12345678-1234-1234-1234-123456789012\"\n }\n }\n },\n \"contributingWorkspaces\" : [ ]\n },\n \"status\" : {\n \"metering\" : \"NOT_DEFINED\",\n \"marketPlace\" : {\n \"status\" : \"UNPUBLISHED\"\n },\n \"platform\" : \"ACTIVE\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatforms/cac78b51-a8b1-4bab-a96a-27268a21514f\"\n },\n \"owner\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/test-workspace\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Platforms"
],
"summary": "Delete platform",
"description": "Delete a meshPlatform by its UUID. WARNING: Deleting a meshPlatform has significant consequences. All associated meshTenants will be automatically purged in meshStack, but the actual cloud resources remain untouched. Usage reports for the current month will not be finalized and will not be included in chargeback statements. Users will lose access to platform tenants via meshStack but can still access them directly in the cloud platform. You cannot create a new meshPlatform with the same identifier in the same location. This operation cannot be undone. Ensure you have proper backups and have communicated the impact to affected users.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatform-Delete-V",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID of the meshPlatform.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatform.v2.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshplatformtypes/{identifier}": {
"get": {
"tags": [
"Platform Types"
],
"summary": "Get platform type",
"description": "Retrieve detailed information about a specific meshPlatformType\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatformTypeV1",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The identifier that uniquely identifies the meshPlatformType.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatformtype.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshplatformtype.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatformTypeV1"
},
"examples": {
"meshPlatformTypeV1": {
"value": "{\n \"kind\" : \"meshPlatformType\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"5503a2ca-85a4-4aa5-82a3-08f491db5785\",\n \"name\" : \"my-platform-type\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"My Platform Type\",\n \"category\" : \"CUSTOM\",\n \"defaultEndpoint\" : \"https://custom.example.com\",\n \"icon\" : \"data:image/png;base64,iVBORw0KGgo...\"\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:39.026304500Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatformtypes/my-platform-type\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Platform Types"
],
"summary": "Update platform type",
"description": "Update an existing meshPlatformType or create a new one if it doesn't exist.\n\nUse this endpoint to modify the display name, endpoint URL, icon, or status of a custom platform type.\nYou can deactivate a platform type by setting its status to 'DEACTIVATED', which prevents creation\nof new platform instances of this type.\n\nNote: The category cannot be changed as it is always 'CUSTOM' for custom platform types.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatformTypeV1Put",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The platform type identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatformtype.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatformtype.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshplatformtype.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshplatformtypes382571989"
},
"examples": {
"meshPlatformTypeV1Put": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshPlatformType\",\n \"metadata\": {\n \"name\": \"my-platform-type\",\n \"ownedByWorkspace\": \"platform-team\"\n },\n \"spec\": {\n \"displayName\": \"Updated Custom Platform\",\n \"category\": \"CUSTOM\",\n \"defaultEndpoint\": \"https://updated.example.com\",\n \"icon\": \"updated-icon\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshplatformtype.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshPlatformTypeV1Put"
},
"examples": {
"meshPlatformTypeV1Put": {
"value": "{\n \"kind\" : \"meshPlatformType\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"uuid\" : \"5503a2ca-85a4-4aa5-82a3-08f491db5785\",\n \"name\" : \"my-platform-type\",\n \"ownedByWorkspace\" : \"platform-team\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated Custom Platform\",\n \"category\" : \"CUSTOM\",\n \"defaultEndpoint\" : \"https://updated.example.com\",\n \"icon\" : \"updated-icon\"\n },\n \"status\" : {\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:39.026304500Z\"\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshplatformtypes/my-platform-type\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Platform Types"
],
"summary": "Deactivate platform type",
"description": "Deactivate a specific meshPlatformType by identifier. Only platform types of category 'CUSTOM' can be\ndeactivated. Deactivating a meshPlatformType will set its status to 'DEACTIVATED', preventing new\nplatforms from being created of this type. Existing platforms will not be affected.\n\nOnly admin users with delete permissions on platforms can deactivate platform types.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshPlatformTypeV1Delete",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The platform type identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshplatformtype.v1.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojectbindings/groupbindings": {
"get": {
"tags": [
"Project Bindings"
],
"summary": "List project group bindings",
"description": "List all meshProjectGroupBindings for a specific project with optional filtering and pagination.\n\nA meshProjectGroupBinding is an assignment of groups to a project with a specified project role.\nThese project roles grant groups a specific set of permissions within the cloud platforms used\nby the project. The actual permissions that the role have within the platform tenant are\ndetermined by the policies set by your cloud foundation team.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectGroupBindingListV3",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "The identifier of the workspace containing the project with the requested bindings (Optional)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectIdentifier",
"in": "query",
"description": "The project identifier of the project that contains the requested bindings (Optional)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectGroupBindingListV3"
},
"examples": {
"meshProjectGroupBindingListV3": {
"value": "{\n \"_embedded\" : {\n \"meshProjectGroupBindings\" : [ {\n \"kind\" : \"meshProjectGroupBinding\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"name\" : \"c9a1f9a1-de30-433e-b636-884eaa79a3f5\"\n },\n \"roleRef\" : {\n \"name\" : \"Project User\"\n },\n \"targetRef\" : {\n \"name\" : \"test-project-1\",\n \"displayName\" : \"Test Project 1\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"subject\" : {\n \"name\" : \"testgroup\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings/c9a1f9a1-de30-433e-b636-884eaa79a3f5\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings?workspaceIdentifier=test-workspace&projectIdentifier=test-project-1\"\n }\n },\n \"page\" : {\n \"size\" : 50,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Project Bindings"
],
"summary": "Create project group binding",
"description": "Create a new meshProjectGroupBinding to assign a group to a project with a specific role\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectGroupBindingCreateV3",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectbindings-groupbindings1480218446"
},
"examples": {
"meshProjectGroupBindingCreateV3": {
"value": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"meshProjectGroupBinding\",\n \"metadata\": {\n \"name\": \"group-binding-name\"\n },\n \"targetRef\": {\n \"name\": \"test-project-1\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"roleRef\": { \"name\": \"Project Reader\" },\n \"subject\": {\n \"name\" : \"testgroup\"\n }\n} "
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectGroupBindingCreateV3"
},
"examples": {
"meshProjectGroupBindingCreateV3": {
"value": "{\n \"kind\" : \"meshProjectGroupBinding\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"name\" : \"group-binding-name\"\n },\n \"roleRef\" : {\n \"name\" : \"Project Reader\"\n },\n \"targetRef\" : {\n \"name\" : \"test-project-1\",\n \"displayName\" : \"Test Project 1\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"subject\" : {\n \"name\" : \"testgroup\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings/group-binding-name\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojectbindings/userbindings": {
"get": {
"tags": [
"Project Bindings"
],
"summary": "List project user bindings",
"description": "List all meshProjectUserBindings for a specific project with optional filtering and pagination.\n\nA meshProjectUserBinding is an assignment of users to a project with a specified project role.\nThese project roles grant users a specific set of permissions within the cloud platforms used\nby the project. The actual permissions that the role have within the platform tenant are determined\nby the policies set by your cloud foundation team.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectUserBindingListV3",
"parameters": [
{
"name": "workspaceIdentifier",
"in": "query",
"description": "The identifier of the workspace the project with the bindings belongs to. (Optional)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectIdentifier",
"in": "query",
"description": "The project identifier of the project that contains the requested bindings. (Optional)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectUserBindingListV3"
},
"examples": {
"meshProjectUserBindingListV3": {
"value": "{\n \"_embedded\" : {\n \"meshProjectUserBindings\" : [ {\n \"kind\" : \"meshProjectUserBinding\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"name\" : \"7c4f01e3-4bb9-4c8f-bac5-f374e4d425e0\"\n },\n \"roleRef\" : {\n \"name\" : \"Project User\"\n },\n \"targetRef\" : {\n \"name\" : \"test-project-1\",\n \"displayName\" : \"Test Project 1\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"subject\" : {\n \"name\" : \"username1\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings/7c4f01e3-4bb9-4c8f-bac5-f374e4d425e0\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings?workspaceIdentifier=test-workspace&projectIdentifier=test-project-1\"\n }\n },\n \"page\" : {\n \"size\" : 50,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"post": {
"tags": [
"Project Bindings"
],
"summary": "Create project user binding",
"description": "Create a new meshProjectUserBinding to assign a user to a project with a specific role, which grants\nthem the corresponding permissions within the cloud platform. Before users can be assigned to a project,\nthey must first be added to the workspace that owns that project.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectUserBindingCreateV3",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectbindings-userbindings226655957"
},
"examples": {
"meshProjectUserBindingCreateV3": {
"value": "{\n \"apiVersion\": \"v3\",\n \"kind\": \"meshProjectUserBinding\",\n \"metadata\": {\n \"name\": \"user-binding-name\"\n },\n \"targetRef\": {\n \"name\": \"test-project-1\",\n \"ownedByWorkspace\": \"test-workspace\"\n },\n \"roleRef\": { \"name\": \"Project Reader\" },\n \"subject\": {\n \"name\" : \"username3\"\n }\n} "
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectUserBindingCreateV3"
},
"examples": {
"meshProjectUserBindingCreateV3": {
"value": "{\n \"kind\" : \"meshProjectUserBinding\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"name\" : \"user-binding-name\"\n },\n \"roleRef\" : {\n \"name\" : \"Project Reader\"\n },\n \"targetRef\" : {\n \"name\" : \"test-project-1\",\n \"displayName\" : \"Test Project 1\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"subject\" : {\n \"name\" : \"username3\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings/user-binding-name\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojectroles/{identifier}": {
"get": {
"tags": [
"Project Role Definitions"
],
"summary": "Get project role",
"description": "Retrieve detailed information about a specific meshProjectRole\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectRoleV1",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The identifier that uniquely identifies the meshProjectRole.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectrole.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshprojectrole.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectRoleV1"
},
"examples": {
"meshProjectRoleV1": {
"value": "{\n \"kind\" : \"meshProjectRole\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"project-admin\",\n \"tags\" : {\n \"priority\" : [ \"high\" ],\n \"access\" : [ \"admin\" ]\n }\n },\n \"spec\" : {\n \"name\" : \"Project Administrator\",\n \"description\" : \"Full administrative access to projects\",\n \"rank\" : 100\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles/project-admin\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Project Role Definitions"
],
"summary": "Update project role",
"description": "Update an existing meshProjectRole or create a new one if it doesn't exist.\nUse this endpoint to update role definitions, descriptions, or modify role hierarchies by adjusting the rank.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectRoleV1Put",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The project role identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectrole.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectrole.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshprojectrole.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectroles486549215"
},
"examples": {
"meshProjectRoleV1Put": {
"value": "{\n \"apiVersion\": \"v1\",\n \"kind\": \"meshProjectRole\",\n \"metadata\": {\n \"name\": \"project-member\",\n \"tags\": {\n \"priority\": [\"standard\"],\n \"access\": [\"user\"],\n \"department\": [\"engineering\"]\n }\n },\n \"spec\": {\n \"name\": \"Project Member\",\n \"description\": \"Updated standard user access to projects with additional permissions\",\n \"rank\": 50\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshprojectrole.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectRoleV1Put"
},
"examples": {
"meshProjectRoleV1Put": {
"value": "{\n \"kind\" : \"meshProjectRole\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"project-member\",\n \"tags\" : {\n \"priority\" : [ \"standard\" ],\n \"access\" : [ \"user\" ],\n \"department\" : [ \"engineering\" ]\n }\n },\n \"spec\" : {\n \"name\" : \"Project Member\",\n \"description\" : \"Updated standard user access to projects with additional permissions\",\n \"rank\" : 50\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectroles/project-member\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Project Role Definitions"
],
"summary": "Delete project role",
"description": "Delete a meshProjectRole to remove it from the system.\nDeleting a project role is only possible if no users are assigned to the given role.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectRoleV1Delete",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The project role identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectrole.v1.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojects/{fullProjectIdentifier}": {
"get": {
"tags": [
"Projects"
],
"summary": "Get project by identifier",
"description": "Get a specific meshProject by its identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectV2",
"parameters": [
{
"name": "fullProjectIdentifier",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshproject.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshproject.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectV2"
},
"examples": {
"meshProjectV2": {
"value": "{\n \"kind\" : \"meshProject\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-project-1\",\n \"ownedByWorkspace\" : \"4kkx3mpdsv1\",\n \"createdOn\" : \"2024-01-01T00:00:00Z\",\n \"deletedOn\" : \"2026-06-03T14:05:43.138016187Z\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated Test Project 1\",\n \"tags\" : {\n \"environment\" : [ \"production\" ],\n \"costCenter\" : [ \"4058\" ]\n },\n \"paymentMethodIdentifier\" : \"test-payment\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects/4kkx3mpdsv1.test-project-1\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"activePaymentMethod\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment\"\n },\n \"meshprojectuserbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"meshprojectgroupbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Projects"
],
"summary": "Update a project",
"description": "Update an existing meshProject by full project identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectPut",
"parameters": [
{
"name": "fullProjectIdentifier",
"in": "path",
"description": "The full project identifier is a unique string consisting of the workspace identifier and project identifier separated by '.'.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshproject.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshproject.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshproject.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojects-fullProjectIdentifier-1933825965"
},
"examples": {
"meshProjectPut": {
"value": "{\n \"apiVersion\" : \"v2\",\n \"kind\": \"meshProject\",\n \"spec\" : {\n \"displayName\" : \"Updated Test Project 1\",\n \"tags\" : {\n \"environment\": [\"production\"],\n \"costCenter\": [\"4058\"]\n },\n \"paymentMethodIdentifier\" : \"test-payment\"\n },\n \"metadata\" : {\n \"name\" : \"test-project-1\",\n \"ownedByWorkspace\" : \"4kkx3mpdsv1\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshproject.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectPut"
},
"examples": {
"meshProjectPut": {
"value": "{\n \"kind\" : \"meshProject\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"test-project-1\",\n \"ownedByWorkspace\" : \"4kkx3mpdsv1\",\n \"createdOn\" : \"2024-01-01T00:00:00Z\"\n },\n \"spec\" : {\n \"displayName\" : \"Updated Test Project 1\",\n \"tags\" : {\n \"environment\" : [ \"production\" ],\n \"costCenter\" : [ \"4058\" ]\n },\n \"paymentMethodIdentifier\" : \"test-payment\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects/4kkx3mpdsv1.test-project-1\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"activePaymentMethod\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods/test-payment\"\n },\n \"meshprojectuserbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n },\n \"meshprojectgroupbindings\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings?workspaceIdentifier=4kkx3mpdsv1&projectIdentifier=test-project-1\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Projects"
],
"summary": "Delete project",
"description": "Delete a specific meshProject by full project identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectDeleteV2",
"parameters": [
{
"name": "fullProjectIdentifier",
"in": "path",
"description": "The full project identifier is a unique string consisting of the workspace identifier and project identifier separated by '.'.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshproject.v2.hal+json"
}
],
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshserviceinstances/{serviceInstanceId}": {
"get": {
"tags": [
"Service Instances"
],
"summary": "Get a service instance",
"description": "Get a specific service instance\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshServiceInstanceGet",
"parameters": [
{
"name": "serviceInstanceId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshServiceInstanceGet"
},
"examples": {
"meshServiceInstanceGet": {
"value": "{\n \"kind\" : \"meshServiceInstance\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"ownedByProject\" : \"production\",\n \"ownedByWorkspace\" : \"my-mobile-app-team\",\n \"marketplaceIdentifier\" : \"eu-west-1\",\n \"instanceId\" : \"serviceInstanceId\"\n },\n \"spec\" : {\n \"displayName\" : \"New SI updated\",\n \"serviceId\" : \"4kkx3mtdg20\",\n \"planId\" : \"4kkx3mtdg22\",\n \"serviceBrokerIdentifier\" : \"4kkx3mtdg18\",\n \"parameters\" : {\n \"key1\" : \"updatedValue1\",\n \"key2\" : \"updatedValue2\"\n },\n \"creator\" : \"Unknown\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshserviceinstances/serviceInstanceId\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Service Instances"
],
"summary": "Update a service instance",
"description": "Update a specific mesh instance\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshServiceInstancePut",
"parameters": [
{
"name": "serviceInstanceId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshserviceinstance.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshserviceinstances-serviceInstanceId1565178963"
},
"examples": {
"meshServiceInstancePut": {
"value": "{\n \"apiVersion\" : \"v2\",\n \"kind\" : \"meshServiceInstance\",\n \"metadata\" : {\n \"ownedByProject\" : \"production\",\n \"ownedByWorkspace\" : \"my-mobile-app-team\",\n \"marketplaceIdentifier\" : \"eu-west-1\",\n \"instanceId\" : \"serviceInstanceId\"\n },\n \"spec\" : {\n \"displayName\" : \"New SI updated\",\n \"serviceId\" : \"4kkx3mtdg20\",\n \"planId\" : \"4kkx3mtdg22\",\n \"parameters\" : {\n \"key1\" : \"updatedValue1\",\n \"key2\" : \"updatedValue2\"\n },\n \"creator\" : \"alice@example.com\"\n }\n}"
}
}
}
}
},
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Service Instances"
],
"summary": "Delete a service instance",
"description": "Delete a specific service instance\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshServiceInstanceDelete",
"parameters": [
{
"name": "serviceInstanceId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshtagdefinitions/{name}": {
"get": {
"tags": [
"Tag Definitions"
],
"summary": "Get tag definition",
"description": "Get a specific meshTagDefinition by its name\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTagDefinition",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The `metadata.name` of the meshTagDefinition.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTagDefinition"
},
"examples": {
"meshTagDefinition": {
"value": "{\n \"kind\" : \"meshTagDefinition\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"meshWorkspace.costCenter\"\n },\n \"spec\" : {\n \"targetKind\" : \"meshWorkspace\",\n \"key\" : \"costCenter\",\n \"valueType\" : {\n \"string\" : {\n \"defaultValue\" : \"1001\",\n \"validationRegex\" : \"^\\\\d{4}$\"\n }\n },\n \"description\" : \"Must be exactly 4 digits.\",\n \"displayName\" : \"Cost Center\",\n \"sortOrder\" : 9999,\n \"mandatory\" : true,\n \"immutable\" : false,\n \"restricted\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions/meshWorkspace.costCenter\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Tag Definitions"
],
"summary": "Update tag definition",
"description": "Create or update an existing meshTagDefinition by name\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTagDefinitionPut",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The `metadata.name` of the meshTagDefinition.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectroles486549215"
},
"examples": {
"meshTagDefinitionPut": {
"value": "{\n \"kind\" : \"meshTagDefinition\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"meshWorkspace.costCenter\"\n },\n \"spec\" : {\n \"targetKind\" : \"meshWorkspace\",\n \"key\" : \"costCenter\",\n \"valueType\" : {\n \"string\" : {\n \"defaultValue\" : \"1001\",\n \"validationRegex\" : \"^\\\\d{4}$\"\n },\n \"email\" : null,\n \"integer\" : null,\n \"number\" : null,\n \"singleSelect\" : null,\n \"multiSelect\" : null\n },\n \"description\" : \"Updated description\",\n \"displayName\" : \"Updated display name\",\n \"sortOrder\" : 9999,\n \"mandatory\" : true,\n \"immutable\" : false,\n \"restricted\" : false,\n \"replicationKey\" : \"updatedReplicationKey\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTagDefinitionPut"
},
"examples": {
"meshTagDefinitionPut": {
"value": "{\n \"kind\" : \"meshTagDefinition\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"meshWorkspace.costCenter\"\n },\n \"spec\" : {\n \"targetKind\" : \"meshWorkspace\",\n \"key\" : \"costCenter\",\n \"valueType\" : {\n \"string\" : {\n \"defaultValue\" : \"1001\",\n \"validationRegex\" : \"^\\\\d{4}$\"\n }\n },\n \"description\" : \"Updated description\",\n \"displayName\" : \"Updated display name\",\n \"sortOrder\" : 9999,\n \"mandatory\" : true,\n \"immutable\" : false,\n \"restricted\" : false,\n \"replicationKey\" : \"updatedReplicationKey\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtagdefinitions/meshWorkspace.costCenter\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Tag Definitions"
],
"summary": "Delete tag definition",
"description": "Delete a specific meshTagDefinition by name.\nPlease note that deleting a meshTagDefinition will also remove all tag values for the `key` from\nall meshObjects specified by its `targetKind`.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTagDefinitionDelete",
"parameters": [
{
"name": "name",
"in": "path",
"description": "The `metadata.name` of the meshTagDefinition.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtagdefinition.v1.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshtenants/{identifier}": {
"delete": {
"tags": [
"Tenants"
],
"summary": "Delete tenant V3",
"description": "Delete a specific meshTenant by its identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTenantDeleteV3",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The tenant identifier that uniquely identifies the meshTenant.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "purge",
"in": "query",
"description": "Optional parameter for deletion. If set to `true`, the meshTenant will be immediately and permanently removed from meshStack's internal state without waiting for manual deletion approval or replication. This operation only affects meshStack and does not delete or modify anything in the cloud platform tenant itself. Requires 'Delete Tenants of platforms operated by your workspace' or tenant deletion admin permissions. Default is `false`.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshtenants/{tenantIdentifier}": {
"get": {
"tags": [
"Tenants"
],
"summary": "Get tenant V3",
"description": "Get a specific meshTenant by its identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTenantV3",
"parameters": [
{
"name": "tenantIdentifier",
"in": "path",
"description": "The tenant identifier that uniquely identifies the meshTenant.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtenant.v3.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshtenant.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTenantV3"
},
"examples": {
"meshTenantV3": {
"value": "{\n \"kind\" : \"meshTenant\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"ownedByProject\" : \"test-project\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"platformIdentifier\" : \"aws.aws-meshstack-dev\",\n \"deletedOn\" : \"2026-06-04T14:05:46.268698474Z\",\n \"assignedTags\" : { },\n \"tenantIdentifier\" : \"test-workspace.test-project.aws.aws-meshstack-dev\"\n },\n \"spec\" : {\n \"localId\" : \"c61f8950-301b-48c4-98cb-08e71926005b\",\n \"landingZoneIdentifier\" : \"stage-dev\",\n \"quotas\" : [ {\n \"key\" : \"limits.cpu\",\n \"value\" : 2000\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 10000\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/test-workspace.test-project.aws.aws-meshstack-dev\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=test-workspace&projectIdentifier=test-project&platformIdentifier=aws.aws-meshstack-dev\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshtenants/{uuid}": {
"get": {
"tags": [
"Tenants"
],
"summary": "Get tenant V4",
"description": "Retrieve detailed information about a specific meshTenant.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTenantV4",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshTenant.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "meshApi is versioned and you should use `application/vnd.meshcloud.api.meshtenant.v4-preview.hal+json` as an `Accept` header to be guaranteed the V4 response format of this endpoint. New versions might be added in future.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshtenant.v4-preview.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshtenant.v4-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshTenantV4"
},
"examples": {
"meshTenantV4": {
"value": "{\n \"kind\" : \"meshTenant\",\n \"apiVersion\" : \"v4-preview\",\n \"metadata\" : {\n \"uuid\" : \"b9b172ad-a848-4dc1-8e09-fdff8adb5003\",\n \"ownedByWorkspace\" : \"test-workspace\",\n \"ownedByProject\" : \"test-project\",\n \"createdOn\" : \"2026-06-03T14:05:47.226906155Z\"\n },\n \"spec\" : {\n \"platformIdentifier\" : \"sr.eu-de-netde\",\n \"landingZoneIdentifier\" : \"stage-dev\",\n \"platformTenantId\" : \"bfb96178-ea6f-4648-a6cc-22f4f5d130af\",\n \"quotas\" : [ {\n \"key\" : \"limits.cpu\",\n \"value\" : 2000\n }, {\n \"key\" : \"limits.memory\",\n \"value\" : 10000\n } ]\n },\n \"status\" : {\n \"tenantName\" : \"test-workspace.test-project.sr.eu-de-netde\",\n \"platformTypeIdentifier\" : \"SERVICEREGISTRY\",\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/b9b172ad-a848-4dc1-8e09-fdff8adb5003\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=test-workspace&projectIdentifier=test-project&platformIdentifier=sr.eu-de-netde\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Tenants"
],
"summary": "Delete tenant V4",
"description": "Submits an existing meshTenant for deletion. meshTenant deletion might involve manual action on operator side, so the meshTenant might not be immediately deleted but rather marked for deletion.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshTenantDeleteV4",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The unique UUID of the meshTenant.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "purge",
"in": "query",
"description": "Optional parameter for deletion. If set to `true`, the meshTenant will be immediately and permanently removed from meshStack's internal state without waiting for manual deletion approval or replication. This operation only affects meshStack and does not delete or modify anything in the cloud platform tenant itself. Requires 'Delete Tenants of platforms operated by your workspace' or tenant deletion admin permissions. Default is `false`.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshusers/{username}": {
"get": {
"tags": [
"Users"
],
"summary": "Get user",
"description": "Get a single meshUser. Deleted meshUsers are not provided via this endpoint.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshUserV2",
"parameters": [
{
"name": "username",
"in": "path",
"description": "The username that uniquely identifies the meshUser.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshuser.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshUserV2"
},
"examples": {
"meshUserV2": {
"value": "{\n \"kind\" : \"meshUser\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"uuid\" : \"8834a53b-f903-4266-92ad-6c224beaf54b\",\n \"name\" : \"john-doe\"\n },\n \"spec\" : {\n \"email\" : \"jdoe@example.com\",\n \"firstName\" : \"John\",\n \"lastName\" : \"Doe\",\n \"euid\" : \"7b2b2f62-36aa-413a-b24d-a053b3082bbe\",\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers/john-doe\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?username=john-doe\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Users"
],
"summary": "Update user",
"description": "Create or update a single meshUser.\n\nThis endpoint is only available when SCIM provisioning is disabled for this meshStack and will\notherwise reject all requests.\n\nPlease note that changing attributes like metadata.name (also referred to as username) and euid\ncan have serious consequences for cloud platforms and building blocks consuming these attributes.\nProceed only with extreme caution.\n\nYou should consider updating these attributes as a measure of last resort to resolve IAM consistency\nissues in your specific setup of meshStack and connected systems. We recommend deleting the meshUser\nand creating a new one as a much safer alternative.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshUserV2Put",
"parameters": [
{
"name": "username",
"in": "path",
"description": "The username that uniquely identifies the meshUser.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshuser.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshusers-username-179515684"
},
"examples": {
"meshUserV2Put": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshUser\",\n \"metadata\": {\n \"name\": \"samira-johnson\"\n },\n \"spec\": {\n \"email\": \"sjohnson@example.com\",\n \"euid\": \"3c0bb04d-a140-4cd3-868a-46fbcce8b0f8\",\n \"firstName\": \"Samira\",\n \"lastName\": \"Johnson\",\n \"tags\": {}\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshuser.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshUserV2Put"
},
"examples": {
"meshUserV2Put": {
"value": "{\n \"kind\" : \"meshUser\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"uuid\" : \"3419a533-7190-403f-a4b7-8fbb3e4a6fc1\",\n \"name\" : \"samira-johnson\"\n },\n \"spec\" : {\n \"email\" : \"sjohnson@example.com\",\n \"firstName\" : \"Samira\",\n \"lastName\" : \"Johnson\",\n \"euid\" : \"3c0bb04d-a140-4cd3-868a-46fbcce8b0f8\",\n \"tags\" : {\n \"environment\" : [ \"dev\", \"test\", \"qa\" ]\n }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers/samira-johnson\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?username=samira-johnson\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete user",
"description": "Delete a single meshUser.\n\nThis endpoint is always available, even when SCIM provisioning is enabled for this meshStack. When\nSCIM is enabled, prefer de-provisioning the user in the connected IAM system instead of using this\nendpoint to avoid unintended side effects like re-provisioning of the user.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshUserV2Delete",
"parameters": [
{
"name": "username",
"in": "path",
"description": "The username that uniquely identifies the meshUser.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshworkspacebindings/groupbindings": {
"get": {
"tags": [
"Workspace Bindings"
],
"summary": "List workspace group bindings",
"description": "List and filter workspace group bindings.\n\nA meshWorkspaceGroupBinding is an assignment of a group to a workspace with a specified workspace role.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceGroupBindingList",
"parameters": [
{
"name": "username",
"in": "query",
"description": "Filter for group bindings associated to the given user",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceRole",
"in": "query",
"description": "Filter for group bindings with the given workspace role",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceGroupBindingList"
},
"examples": {
"meshWorkspaceGroupBindingList": {
"value": "{\n \"_embedded\" : {\n \"meshWorkspaceGroupBindings\" : [ {\n \"kind\" : \"meshWorkspaceGroupBinding\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"e716d1ee-0b1c-417c-8b17-9c8e97ee1d0b\"\n },\n \"roleRef\" : {\n \"name\" : \"Workspace Manager\"\n },\n \"targetRef\" : {\n \"name\" : \"test-workspace\",\n \"displayName\" : \"test-workspace Workspace\"\n },\n \"subject\" : {\n \"name\" : \"testgroup\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/groupbindings/e716d1ee-0b1c-417c-8b17-9c8e97ee1d0b\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/groupbindings?username=john.doe49a0&workspaceRole=Workspace%20Manager\"\n }\n },\n \"page\" : {\n \"size\" : 50,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
},
"post": {
"tags": [
"Workspace Bindings"
],
"summary": "Create workspace group binding",
"description": "This creates a new group binding and associates a user group together with a workspace role to a workspace.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceGroupBindingCreate",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshworkspacebindings-groupbindings-439969197"
},
"examples": {
"meshWorkspaceGroupBindingCreate": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshWorkspaceGroupBinding\",\n \"metadata\": {\n \"name\": \"my-group-binding-name\"\n },\n \"targetRef\": {\n \"name\": \"test-workspace\"\n },\n \"roleRef\": { \"name\": \"Workspace Member\" },\n \"subject\": {\n \"name\" : \"testgroup\"\n }\n} "
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceGroupBindingCreate"
},
"examples": {
"meshWorkspaceGroupBindingCreate": {
"value": "{\n \"kind\" : \"meshWorkspaceGroupBinding\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"my-group-binding-name\"\n },\n \"roleRef\" : {\n \"name\" : \"Workspace Member\"\n },\n \"targetRef\" : {\n \"name\" : \"test-workspace\",\n \"displayName\" : \"test-workspace Workspace\"\n },\n \"subject\" : {\n \"name\" : \"testgroup\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/groupbindings/my-group-binding-name\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshworkspacebindings/userbindings": {
"get": {
"tags": [
"Workspace Bindings"
],
"summary": "List workspace user bindings",
"description": "Provides a paged list of meshWorkspaceUserBindings.\n\nA meshWorkspaceUserBinding is an assignment of users to a workspace with a specified workspace role.\nPlease note that this endpoint can only be used with API users for now. Support for API keys will\nbe added in the future.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceUserBindingList",
"parameters": [
{
"name": "username",
"in": "query",
"description": "Filter for user bindings associated to the given user",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceRole",
"in": "query",
"description": "Filter for user bindings with the given workspace role",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "workspaceIdentifier",
"in": "query",
"description": "Filter for user bindings associated to the given workspace",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceUserBindingList"
},
"examples": {
"meshWorkspaceUserBindingList": {
"value": "{\n \"_embedded\" : {\n \"meshWorkspaceUserBindings\" : [ {\n \"kind\" : \"meshWorkspaceUserBinding\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"user-binding-name\"\n },\n \"roleRef\" : {\n \"name\" : \"Workspace Manager\"\n },\n \"targetRef\" : {\n \"name\" : \"test-workspace\",\n \"displayName\" : \"test-workspace Workspace\"\n },\n \"subject\" : {\n \"name\" : \"john.doe49a0\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/userbindings/user-binding-name\"\n }\n }\n } ]\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/userbindings?username=john.doe49a0&workspaceRole=Workspace%20Manager&workspaceIdentifier=test-workspace\"\n }\n },\n \"page\" : {\n \"size\" : 50,\n \"totalElements\" : 1,\n \"totalPages\" : 1,\n \"number\" : 0\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
},
"post": {
"tags": [
"Workspace Bindings"
],
"summary": "Create workspace user binding",
"description": "Creating a meshWorkspaceUserBinding assigns the user to a workspace with a specified workspace role.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceUserBindingCreate",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshworkspacebindings-userbindings-1470058865"
},
"examples": {
"meshWorkspaceUserBindingCreate": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshWorkspaceUserBinding\",\n \"metadata\": {\n \"name\": \"another-user-binding-name\"\n },\n \"targetRef\": {\n \"name\": \"test-workspace\"\n },\n \"roleRef\": { \"name\": \"Workspace Member\" },\n \"subject\": {\n \"name\" : \"john.doe49a0\"\n }\n} "
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceUserBindingCreate"
},
"examples": {
"meshWorkspaceUserBindingCreate": {
"value": "{\n \"kind\" : \"meshWorkspaceUserBinding\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"another-user-binding-name\"\n },\n \"roleRef\" : {\n \"name\" : \"Workspace Member\"\n },\n \"targetRef\" : {\n \"name\" : \"test-workspace\",\n \"displayName\" : \"test-workspace Workspace\"\n },\n \"subject\" : {\n \"name\" : \"john.doe49a0\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/userbindings/another-user-binding-name\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshworkspaces/{identifier}": {
"get": {
"tags": [
"Workspaces"
],
"summary": "Get workspace",
"description": "Get a specific meshWorkspace by identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshWorkspace",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The workspace identifier that uniquely identifies the meshWorkspace.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspace.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspace.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspace"
},
"examples": {
"meshWorkspace": {
"value": "{\n \"kind\" : \"meshWorkspace\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"admin-customer\",\n \"tags\" : { },\n \"createdOn\" : \"2026-06-03T14:04:11Z\"\n },\n \"spec\" : {\n \"displayName\" : \"admin-customer\",\n \"platformBuilderAccessEnabled\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/admin-customer\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=admin-customer\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=admin-customer\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=admin-customer\"\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=admin-customer\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?workspaceIdentifier=admin-customer\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"put": {
"tags": [
"Workspaces"
],
"summary": "Update workspace",
"description": "Create or update an existing meshWorkspace by identifier.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshWorkspacePut",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The workspace identifier that uniquely identifies the meshWorkspace.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspace.v2.hal+json"
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspace.v2.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshworkspace.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshprojectroles486549215"
},
"examples": {
"meshWorkspacePut": {
"value": "{\n \"apiVersion\": \"v2\",\n \"kind\": \"meshWorkspace\",\n \"metadata\": {\n \"name\": \"my-workspace\",\n \"tags\": {\n \"costCenter\": [\"4058\"],\n \"workspaceOwner\": [\"Anna Admin\"]\n }\n },\n \"spec\": {\n \"displayName\": \"updated workspace name\",\n \"platformBuilderAccessEnabled\": false\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspace.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspacePut"
},
"examples": {
"meshWorkspacePut": {
"value": "{\n \"kind\" : \"meshWorkspace\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"my-workspace\",\n \"tags\" : {\n \"costCenter\" : [ \"4058\" ],\n \"workspaceOwner\" : [ \"Anna Admin\" ]\n },\n \"createdOn\" : \"2026-06-03T14:05:51.822610168Z\"\n },\n \"spec\" : {\n \"displayName\" : \"updated workspace name\",\n \"platformBuilderAccessEnabled\" : false\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/my-workspace\"\n },\n \"meshtenants\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants?workspaceIdentifier=my-workspace\"\n },\n \"meshprojects\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojects?workspaceIdentifier=my-workspace\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceIdentifier=my-workspace\"\n },\n \"meshpaymentmethods\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshpaymentmethods?workspaceIdentifier=my-workspace\"\n },\n \"meshworkspaceusergroups\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups?workspaceIdentifier=my-workspace\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Workspaces"
],
"summary": "Delete workspace",
"description": "Delete a meshWorkspace by identifier. This operation marks the workspace as deleted and removes or\ndisconnects all attached objects (e.g. users, workspace user groups and payment methods). Workspace\ndeletion is only possible if the workspace contains no projects and no tenants.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshWorkspaceDelete",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The workspace identifier that uniquely identifies the meshWorkspace.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspace.v2.hal+json"
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshworkspaceusergroups/{fullWorkspaceUserGroupIdentifier}": {
"get": {
"tags": [
"Workspace User Groups"
],
"summary": "Get workspace user group",
"description": "Get a single meshWorkspaceUserGroup by a composed identifier containing workspace-identifier\nand group-identifier connected with a dot (e.g. `workspace-identifier.group-identifier`).\nFor global groups, the workspace identifier is always `meshcloud-global-partner`.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshWorkspaceUserGroup",
"parameters": [
{
"name": "fullWorkspaceUserGroupIdentifier",
"in": "path",
"description": "The full workspace user group identifier consisting of workspace identifier and group identifier separated by '.' (e.g. 'workspace-identifier.group-identifier').",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspaceusergroup.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspaceusergroup.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceUserGroup"
},
"examples": {
"meshWorkspaceUserGroup": {
"value": "{\n \"kind\" : \"meshWorkspaceUserGroup\",\n \"apiVersion\" : \"v1\",\n \"metadata\" : {\n \"name\" : \"my-user-group\",\n \"ownedByWorkspace\" : \"sample-workspace\"\n },\n \"spec\" : {\n \"displayName\" : \"My User Group\",\n \"egid\" : \"e74b9db5-7ac5-42a8-bef9-9f7f0c2738ca\",\n \"members\" : [ \"sample-user\" ],\n \"tags\" : { }\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaceusergroups/sample-workspace.my-user-group\"\n },\n \"meshworkspace\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspaces/sample-workspace\"\n },\n \"meshusers\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshusers?workspaceUserGroupIdentifier=my-user-group\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockruns/{blockRunUuid}/logs": {
"get": {
"tags": [
"Building Block Runs"
],
"summary": "Read building block run logs",
"description": "Read structured logs for all steps in a meshBuildingBlockRun. Admin and platform operator (managed) API keys receive both userMessage and systemMessage. Workspace-scoped API keys always receive userMessage. systemMessage is included for workspace-scoped callers only when runTransparency is enabled on the building block definition; otherwise it is null.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunDownloadLogs",
"parameters": [
{
"name": "blockRunUuid",
"in": "path",
"description": "The UUID of the meshBuildingBlockRun to read logs for.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunDownloadLogs"
},
"examples": {
"meshBuildingBlockRunDownloadLogs": {
"value": "{\n \"steps\" : [ {\n \"displayName\" : \"Init\",\n \"status\" : \"SUCCEEDED\",\n \"userMessage\" : \"Step was successful.\",\n \"systemMessage\" : \"Step was successful.\"\n }, {\n \"displayName\" : \"Pipeline\",\n \"status\" : \"IN_PROGRESS\",\n \"userMessage\" : null,\n \"systemMessage\" : null\n } ]\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblocks/{uuid}/purge": {
"delete": {
"tags": [
"Building Blocks"
],
"summary": "Purge building block",
"description": "Force purge a meshBuildingBlock immediately without waiting for deletion process. With administration\nrights it is also possible to force the purging of a meshBuildingBlock. That way, the deletion mode\nof the meshBuildingBlock\u2019s version is ignored and the meshBuildingBlock is deleted from meshStack.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockForcePurge",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "202"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblocks/{uuid}/retrigger-run": {
"post": {
"tags": [
"Building Blocks"
],
"summary": "Retrigger building block run",
"description": "Triggers a new run for an existing meshBuildingBlock. This creates a new building block run without requiring input changes. The response returns the updated building block.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRetriggerRun",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "The UUID of the meshBuildingBlock to retrigger.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json"
}
],
"responses": {
"202": {
"description": "202",
"content": {
"application/vnd.meshcloud.api.meshbuildingblock.v2-preview.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRetriggerRun"
},
"examples": {
"meshBuildingBlockRetriggerRun": {
"value": "{\n \"kind\" : \"meshBuildingBlock\",\n \"apiVersion\" : \"v2-preview\",\n \"metadata\" : {\n \"uuid\" : \"db435958-06f1-472f-8c24-a82ba1ba2f6f\",\n \"ownedByWorkspace\" : \"my-workspace\"\n },\n \"spec\" : {\n \"buildingBlockDefinitionVersionRef\" : {\n \"uuid\" : \"63f13d8f-aeee-4099-a042-abaea7ecb059\",\n \"kind\" : \"meshBuildingBlockDefinitionVersion\"\n },\n \"targetRef\" : {\n \"uuid\" : \"904ddce4-73b4-4b0d-948c-cfde1d5ad33d\",\n \"kind\" : \"meshTenant\"\n },\n \"displayName\" : \"New BuildingBlock v2\",\n \"inputs\" : {\n \"resourceName\" : {\n \"value\" : \"updated-resource-name\",\n \"valueType\" : \"STRING\",\n \"isSensitive\" : false,\n \"assignmentType\" : \"USER_INPUT\",\n \"updateableByConsumer\" : false\n }\n },\n \"parentBuildingBlocks\" : [ {\n \"buildingBlockUuid\" : \"9ea5cf31-6475-4489-b70b-74113d78ba83\",\n \"definitionUuid\" : \"b23cfb9a-6974-444f-9d33-62134a632373\"\n } ]\n },\n \"status\" : {\n \"status\" : \"PENDING\",\n \"outputs\" : { },\n \"forcePurge\" : false,\n \"lifecycle\" : {\n \"state\" : \"ACTIVE\",\n \"createdOn\" : \"2026-06-03T14:05:14.150666874Z\"\n }\n },\n \"_links\" : {\n \"meshtenant\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location\"\n },\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/db435958-06f1-472f-8c24-a82ba1ba2f6f\"\n },\n \"forcePurge\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshbuildingblocks/db435958-06f1-472f-8c24-a82ba1ba2f6f/purge\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojectbindings/groupbindings/{bindingId}": {
"get": {
"tags": [
"Project Bindings"
],
"summary": "Get project group binding",
"description": "Retrieve detailed information about a specific meshProjectGroupBinding by its identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectGroupBindingV3",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "The identifier of the meshProjectGroupBinding to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshprojectgroupbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectGroupBindingV3"
},
"examples": {
"meshProjectGroupBindingV3": {
"value": "{\n \"kind\" : \"meshProjectGroupBinding\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"name\" : \"c9a1f9a1-de30-433e-b636-884eaa79a3f5\"\n },\n \"roleRef\" : {\n \"name\" : \"Project User\"\n },\n \"targetRef\" : {\n \"name\" : \"test-project-1\",\n \"displayName\" : \"Test Project 1\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"subject\" : {\n \"name\" : \"testgroup\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/groupbindings/c9a1f9a1-de30-433e-b636-884eaa79a3f5\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Project Bindings"
],
"summary": "Delete project group binding",
"description": "Delete a specific meshProjectGroupBinding to remove a group's access from a project.\n This action effectively withdraws the permissions granted to the group within the cloud platforms linked to the project.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectGroupBindingDeleteV3",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "The identifier of the meshProjectGroupBinding to delete.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshprojectbindings/userbindings/{bindingId}": {
"get": {
"tags": [
"Project Bindings"
],
"summary": "Get project user binding",
"description": "Retrieve detailed information about a specific meshProjectUserBinding by its identifier\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectUserBindingV3",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "The identifier of the meshProjectUserBinding to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshprojectuserbinding.v3.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshProjectUserBindingV3"
},
"examples": {
"meshProjectUserBindingV3": {
"value": "{\n \"kind\" : \"meshProjectUserBinding\",\n \"apiVersion\" : \"v3\",\n \"metadata\" : {\n \"name\" : \"7c4f01e3-4bb9-4c8f-bac5-f374e4d425e0\"\n },\n \"roleRef\" : {\n \"name\" : \"Project User\"\n },\n \"targetRef\" : {\n \"name\" : \"test-project-1\",\n \"displayName\" : \"Test Project 1\",\n \"ownedByWorkspace\" : \"test-workspace\"\n },\n \"subject\" : {\n \"name\" : \"username1\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshprojectbindings/userbindings/7c4f01e3-4bb9-4c8f-bac5-f374e4d425e0\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
},
"delete": {
"tags": [
"Project Bindings"
],
"summary": "Delete project user binding",
"description": "Delete a specific meshProjectUserBinding to remove a user's access from a project.\nThis action effectively withdraws the permissions granted to the user within the cloud platforms linked\nto the project.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshProjectUserBindingDeleteV3",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "The identifier of the meshProjectUserBinding to delete.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshworkspacebindings/groupbindings/{bindingId}": {
"get": {
"tags": [
"Workspace Bindings"
],
"summary": "Get workspace group binding",
"description": "Single workspace group binding\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceGroupBinding",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "The ID of the workspace group binding to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspacegroupbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceGroupBinding"
},
"examples": {
"meshWorkspaceGroupBinding": {
"value": "{\n \"kind\" : \"meshWorkspaceGroupBinding\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"e716d1ee-0b1c-417c-8b17-9c8e97ee1d0b\"\n },\n \"roleRef\" : {\n \"name\" : \"Workspace Manager\"\n },\n \"targetRef\" : {\n \"name\" : \"test-workspace\",\n \"displayName\" : \"test-workspace Workspace\"\n },\n \"subject\" : {\n \"name\" : \"testgroup\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/groupbindings/e716d1ee-0b1c-417c-8b17-9c8e97ee1d0b\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
},
"delete": {
"tags": [
"Workspace Bindings"
],
"summary": "Delete workspace group binding",
"description": "Deleting a meshWorkspaceGroupBinding removes the assignment of a group\nfrom a workspace and revokes their associated workspace role.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceGroupBindingDelete",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshworkspacebindings/userbindings/{bindingId}": {
"get": {
"tags": [
"Workspace Bindings"
],
"summary": "Get workspace user binding",
"description": "Single workspace user binding\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceUserBinding",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "The ID of the workspace user binding to retrieve.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshworkspaceuserbinding.v2.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshWorkspaceUserBinding"
},
"examples": {
"meshWorkspaceUserBinding": {
"value": "{\n \"kind\" : \"meshWorkspaceUserBinding\",\n \"apiVersion\" : \"v2\",\n \"metadata\" : {\n \"name\" : \"user-binding-name\"\n },\n \"roleRef\" : {\n \"name\" : \"Workspace Manager\"\n },\n \"targetRef\" : {\n \"name\" : \"test-workspace\",\n \"displayName\" : \"test-workspace Workspace\"\n },\n \"subject\" : {\n \"name\" : \"john.doe49a0\"\n },\n \"_links\" : {\n \"self\" : {\n \"href\" : \"https://mesh-backend-url/api/meshobjects/meshworkspacebindings/userbindings/user-binding-name\"\n }\n }\n}"
}
}
}
}
}
},
"security": [
{
"basic": [
]
}
]
},
"delete": {
"tags": [
"Workspace Bindings"
],
"summary": "Delete workspace user binding",
"description": "Deleting a meshWorkspaceUserBinding removes the assignment of a user from a\nworkspace and revokes their associated workspace role.\n\n**Authentication:** This endpoint supports API User authentication.",
"operationId": "meshWorkspaceUserBindingDelete",
"parameters": [
{
"name": "bindingId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "204"
}
},
"security": [
{
"basic": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockruns/{blockRunUuid}/status/source": {
"post": {
"tags": [
"Building Block Runs"
],
"summary": "Register source for a building block run",
"description": "**Attention**: This API is currently in BETA and subject to change.\n\nIn order to return updates for a run to meshStack, you first need to register one or multiple steps and\ntheir resources of your run execution. It is up to you how many or how you organize your steps. You can\nhowever also just send step results back and the registration takes place on the fly, but in order to\nhave a consistent display and ordering of steps, it is highly advised to pre-register steps and sources.\n\nServices which are called block runner are responsible for executing block runs. Those services use\nthis API to execute and update the run status in meshStack. At the moment it is not possible to create\nand integrate a fully custom block runner, however you can use this API to send back status updates of\nindividual block runs when you build an asynchronous building block (this is a building block which gets\nits execution handed over to an external system by the block runner). You need an API key with the\npermission to update building block runs. Please be aware that you can only update runs whose underlying\nbuilding block definitions are owned by the workspace the API key is scoped to.\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunSourceRegistration",
"parameters": [
{
"name": "blockRunUuid",
"in": "path",
"description": "The UUID of the meshBuildingBlockRun the source and steps should be registered for.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockruns-blockRunUuid-status-source-1604577785"
},
"examples": {
"meshBuildingBlockRunSourceRegistration": {
"value": "{\n \"source\": {\n \"id\": \"github\",\n \"externalRunId\": \"12345\",\n \"externalRunUrl\": \"https://github.com/meshcloud/example/actions/runs/12345678\"\n },\n \"steps\": [{\n \"id\": \"step1\",\n \"displayName\": \"Init\",\n \"status\": \"IN_PROGRESS\"\n },\n {\n \"id\": \"step2\",\n \"displayName\": \"Pipeline\"\n }]\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200"
}
},
"security": [
{
"oauth2": [
]
}
]
}
},
"/api/meshobjects/meshbuildingblockruns/{blockRunUuid}/status/source/{sourceId}": {
"patch": {
"tags": [
"Building Block Runs"
],
"summary": "Update source for a building block run",
"description": "Update source steps for a meshBuildingBlockRun with status changes, messages, and outputs\n\n**Authentication:** This endpoint supports API Key authentication.",
"operationId": "meshBuildingBlockRunSourceUpdate",
"parameters": [
{
"name": "blockRunUuid",
"in": "path",
"description": "The UUID of the meshBuildingBlockRun the source and steps should be updated for.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sourceId",
"in": "path",
"description": "The ID of the source which should be updated.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Accept",
"in": "header",
"description": "This endpoint of meshObject API is individually versioned. Select your desired version using a supported media type.",
"required": true,
"schema": {
"type": "string"
},
"example": "application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json"
}
],
"requestBody": {
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/api-meshobjects-meshbuildingblockruns-blockRunUuid-status-source-sourceId2076900078"
},
"examples": {
"meshBuildingBlockRunSourceUpdate": {
"value": "{\n \"status\": \"IN_PROGRESS\",\n \"steps\": [{\n \"id\": \"step1\",\n \"status\": \"SUCCEEDED\",\n \"userMessage\": \"Step was successful.\",\n \"systemMessage\": \"Step was successful.\",\n \"outputs\": {\n \"outputName\": {\n \"value\": \"hello-world\",\n \"type\": \"STRING\",\n \"isSensitive\": false\n }\n }\n },\n {\n \"id\": \"step2\",\n \"status\": \"IN_PROGRESS\"\n }]\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json": {
"schema": {
"$ref": "#/components/schemas/meshBuildingBlockRunSourceUpdate"
},
"examples": {
"meshBuildingBlockRunSourceUpdate": {
"value": "{\n \"runAborted\" : false\n}"
}
}
}
}
}
},
"security": [
{
"oauth2": [
]
}
]
}
}
},
"components": {
"schemas": {
"meshIntegration-Post-entra_id": {
"title": "meshIntegration-Post-entra_id",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the integration across all integrations.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace identifier that owns this integration."
}
},
"description": "Contains identifiers and ownership information for the integration."
},
"apiVersion": {
"type": "string",
"description": "Version of meshIntegration datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshIntegration."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshIntegration' for this endpoint."
},
"spec": {
"required": [
"config",
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the integration."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"github": {
"required": [
"appId",
"appPrivateKey",
"baseUrl",
"owner",
"runnerRef"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The GitHub organization or user that owns the repositories."
},
"baseUrl": {
"type": "string",
"description": "The base URL of the GitHub API. Use 'https://api.github.com' for GitHub.com or your GitHub Enterprise URL."
},
"appPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The GitHub App private key for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"appId": {
"type": "string",
"description": "The GitHub App ID for authentication."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitHub-specific integration configuration."
},
"entraid": {
"required": [
"clientId",
"clientSecret",
"tenantId"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "The redirect URL to configure in the Entra Id app registration. This field is read-only and computed by the system.",
"nullable": true
},
"clientId": {
"type": "string",
"description": "The application (client) Id registered in the Entra Id tenant."
},
"tenantId": {
"type": "string",
"description": "The Microsoft Entra Id (Azure AD) tenant Id."
},
"clientSecret": {
"type": "object",
"description": "The client secret for authenticating with the Entra Id application. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Entra Id-specific integration configuration."
},
"azuredevops": {
"required": [
"baseUrl",
"organization",
"personalAccessToken",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the Azure DevOps instance. Typically 'https://dev.azure.com' for Azure DevOps Services."
},
"organization": {
"type": "string",
"description": "The Azure DevOps organization name."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
},
"personalAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Personal Access Token (PAT) for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Azure DevOps-specific integration configuration."
},
"gitlab": {
"required": [
"baseUrl",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the GitLab instance. Use 'https://gitlab.com' for GitLab.com or your self-hosted GitLab URL."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitLab-specific integration configuration."
},
"type": {
"type": "string",
"description": "The type of integration. Available types are: 'azuredevops','entraid','github','gitlab','metering','replicator'. EntraId integrations are only available for the admin workspace."
}
},
"description": "Integration configuration. Contains a 'type' field that determines the integration type ('azuredevops','entraid','github','gitlab','metering','replicator') and type-specific properties nested under the corresponding key (e.g., 'github', 'gitlab', 'azuredevops')."
}
},
"description": "All fields in this section describe the integration configuration."
},
"status": {
"required": [
"isBuiltIn",
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the integration. For meshIntegration, only ACTIVE is supported."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the integration was created. This field is automatically set by the system and cannot be modified.",
"nullable": true
}
},
"description": "Lifecycle information of the integration."
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "GCP Workload Identity Pool audience for token exchange."
}
},
"description": "Google Cloud Platform specific WIF configuration."
},
"subject": {
"type": "string",
"description": "OIDC subject claim for Workload Identity Federation. Identifies the workload service account."
},
"aws": {
"required": [
"audience",
"thumbprint"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "AWS STS audience for AssumeRoleWithWebIdentity."
},
"thumbprint": {
"type": "string",
"description": "AWS OIDC provider thumbprint for trust verification."
}
},
"description": "Amazon Web Services specific WIF configuration."
},
"issuer": {
"type": "string",
"description": "OIDC issuer URL for Workload Identity Federation."
},
"azure": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "Azure AD audience for workload identity federation."
}
},
"description": "Microsoft Azure specific WIF configuration."
}
},
"description": "Workload Identity Federation (WIF) configuration for this integration. Only present for built-in integrations. Provides OIDC issuer, subject, and cloud provider-specific configuration needed to set up trust relationships for workload identity."
},
"isBuiltIn": {
"type": "boolean",
"description": "Indicates whether this integration is a built-in system integration."
}
},
"description": "Status information for integrations. Always includes the isBuiltIn field in responses. Workload Identity Federation (WIF) information is only present for built-in integrations. This field is read-only and ignored in request bodies."
}
}
},
"meshServiceInstanceGet": {
"title": "meshServiceInstanceGet",
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"instanceId",
"marketplaceIdentifier",
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The project that this Service Instance belongs to."
},
"marketplaceIdentifier": {
"type": "string",
"description": "The identifier of the marketplace that this Service Instance belongs to."
},
"instanceId": {
"type": "string",
"description": "The instance id this Service Instance should use."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that this Service Instance belongs to."
}
},
"description": "Metadata and more fields to identify the Service Instance."
},
"apiVersion": {
"type": "string",
"description": "Version of Service Instance datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"creator",
"displayName",
"planId",
"serviceId"
],
"type": "object",
"properties": {
"creator": {
"type": "string",
"description": "The meshUser `username` recorded as the creator of this Service Instance."
},
"displayName": {
"type": "string",
"description": "The display name of the Service Instance."
},
"planId": {
"type": "string",
"description": "The id of the plan for this Service Instance"
},
"serviceId": {
"type": "string",
"description": "The id of the service for the Service Instance"
},
"parameters": {
"type": "object",
"description": "Parameters that were passed to the Service Broker when provisioning or updating the service instance. The structure and content of this field is defined by the service broker.",
"nullable": true
},
"serviceBrokerIdentifier": {
"type": "string",
"description": "The identifier of the Service Broker managing this Service Instance.",
"nullable": true
}
},
"description": "Specifications for the Service Instance."
}
}
},
"api-meshobjects-meshbuildingblockdefinitions-uuid1057849355": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition. It also contains additional meta information like the Building Block Definition creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this endpoint."
},
"spec": {
"required": [
"description",
"displayName",
"targetType",
"useInLandingZonesOnly"
],
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the Building Block Definition as it is shown in meshPanel.",
"nullable": true
},
"documentationUrl": {
"type": "string",
"description": "The URL pointing to documentation of the Building Block Definition. (optional)",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block Definition as it is shown in meshPanel."
},
"supportUrl": {
"type": "string",
"description": "The URL pointing to support of the Building Block Definition. (optional)",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the Building Block Definition as it is shown in meshPanel."
},
"targetType": {
"type": "string",
"description": "The type of Building Block Definition. (One of ['TENANT_LEVEL', 'WORKSPACE_LEVEL'.])"
},
"runTransparency": {
"type": "boolean",
"description": "Specifies the Building Block Definition run control. When set to true, both platform teams and workspace users can view detailed run logs and re-run building blocks. When set to false (default), only platform teams have this access.",
"nullable": true
},
"supportedPlatforms": {
"type": "array",
"description": "Set of the platform types this Building Block Definition supports. Must be non-empty if targetType is 'TENANT_LEVEL', otherwise null. Each entry is a meshPlatformType reference.",
"items": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object. Must be 'meshPlatformType'."
},
"name": {
"type": "string",
"description": "The unique identifier of the platform type (corresponds to the `metadata.name` of a meshPlatformType)."
}
}
}
},
"notificationSubscriberUsernames": {
"type": "array",
"description": "A set of usernames or emails that should be notified as subscribers for this Building Block Definition. Prefix entries with `user:` or `email:`.",
"nullable": true,
"items": {
"type": "string"
}
},
"useInLandingZonesOnly": {
"type": "boolean",
"description": "Indicates whether this Building Block Definition should be used on Landing Zones only."
}
},
"description": "All fields in this section describe the Building Block Definition."
}
}
},
"meshTenantV3": {
"title": "meshTenantV3",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"assignedTags",
"ownedByProject",
"ownedByWorkspace",
"platformIdentifier",
"tenantIdentifier"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The identifier of the meshProject the meshTenant belongs to."
},
"assignedTags": {
"type": "object",
"description": "The tags assigned to this meshTenant originating from meshWorkspace, Payment Method and meshProject. Keep in mind, that values are an array."
},
"deletedOn": {
"type": "string",
"description": "If the meshTenant has been submitted for deletion by a Workspace Manager, the date, the date is represented here (e.g. `2020-12-22T09:37:43Z)`. Otherwise this field is missing.",
"nullable": true
},
"platformIdentifier": {
"type": "string",
"description": "The identifier of the related platform instance"
},
"tenantIdentifier": {
"type": "string",
"description": "The full identifier of this tenant, a concatenation of the workspace identifier, project identifier and platform identifier."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the meshTenant belongs to."
}
},
"description": "Always contains the 'ownedByProject', 'ownedByWorkspace' and 'platformIdentifier' to identify the meshTenant."
},
"apiVersion": {
"type": "string",
"description": "Version of meshTenant datatype. Matches the version provided in the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshTenant' for this endpoint."
},
"spec": {
"required": [
"landingZoneIdentifier",
"localId",
"quotas"
],
"type": "object",
"properties": {
"quotas": {
"type": "array",
"description": "The set of applied Tenant Quotas. They can be set individually per tenant. By default the Landing Zone quotas are applied to new meshTenants.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"landingZoneIdentifier": {
"type": "string",
"description": "The identifier of the Landing Zone of this meshTenant. This field will be empty if the meshTenant has no Landing Zone."
},
"localId": {
"type": "string",
"description": "The localId (platform tenant id) assigned with this meshTenant. It will only be set if the tenant was either imported via meshObject API with a localId or if at least one replication run finished successfully for this tenant."
}
},
"description": "All fields in this section describe the meshTenant."
}
}
},
"meshBuildingBlockDefinitionVersion-get-V1-terraform": {
"title": "meshBuildingBlockDefinitionVersion-get-V1-terraform",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition Version.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition Version belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition Version. It also contains additional meta information like the version creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition Version datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block Definition Version."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinitionVersion' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionRef",
"deletionMode",
"implementation",
"inputs",
"onlyApplyOncePerTenant",
"outputs",
"runnerRef",
"state",
"versionNumber"
],
"type": "object",
"properties": {
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"type"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable display name for the output."
},
"type": {
"type": "string",
"description": "Data type of the output (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE'])."
},
"assignmentType": {
"type": "string",
"description": "How the output is used (One of ['NONE', 'PLATFORM_TENANT_ID', 'SIGN_IN_URL', 'RESOURCE_URL', 'SUMMARY'])."
}
}
}
},
"description": "Map of output definitions for this Building Block Definition Version. The map's keys are output keys, the values are output definition objects. For manual Building Block Definitions, there must not be any outputs that do not match an input with the same key. For manual Building Block Definitions, the type of outputs must match the one from the input with the same key, but must be translated from SINGLE_SELECT to STRING and from MULTI_SELECT to CODE. "
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"isEnvironment",
"isSensitive",
"type",
"updateableByConsumer"
],
"type": "object",
"properties": {
"argument": {
"type": "object",
"description": "Argument value for the input. Required if assignment type is 'STATIC'\nor 'BUILDING_BLOCK_OUTPUT'.\nFor 'BUILDING_BLOCK_OUTPUT', the value must be a string in the\nformat `.` referencing an output of a parent building block.\nMust match the input type if provided. If input type is 'CODE',\nthe value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of\n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"valueValidationRegex": {
"type": "string",
"description": "Regular expression pattern to validate input values. (optional)",
"nullable": true
},
"defaultValue": {
"type": "object",
"description": "Default value for the input (optional). Must match the input type if provided.\nIf input type is 'CODE', the value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of \n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data that should be encrypted."
},
"displayName": {
"type": "string",
"description": "Human-readable display name for the input."
},
"description": {
"type": "string",
"description": "Description explaining the purpose and usage of the input. (optional)",
"nullable": true
},
"selectableValues": {
"type": "array",
"description": "Set of allowed values for the input in case the type is one of 'SINGLE_SELECT' or 'MULTI_SELECT'. (Must be either null or an empty array.)",
"nullable": true,
"items": {
"type": "string"
}
},
"validationRegexErrorMessage": {
"type": "string",
"description": "Error message to display when regex validation fails. (optional)",
"nullable": true
},
"isEnvironment": {
"type": "boolean",
"description": "Whether this input is exposed as a regular or environment variable."
},
"type": {
"type": "string",
"description": "Data type of the input (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE', 'SINGLE_SELECT', 'MULTI_SELECT'])."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether the input value can be updated by the consumer that does not have admin or platform operator permissions."
},
"assignmentType": {
"type": "string",
"description": "How the input value is assigned (One of ['AUTHOR', 'USER_INPUT', 'PLATFORM_OPERATOR_MANUAL_INPUT', 'BUILDING_BLOCK_OUTPUT', 'PLATFORM_TENANT_ID', 'WORKSPACE_IDENTIFIER', 'PROJECT_IDENTIFIER', 'FULL_PLATFORM_IDENTIFIER', 'TENANT_BUILDING_BLOCK_UUID', 'STATIC', 'USER_PERMISSIONS'])."
}
}
}
},
"description": "Map of input definitions for this Building Block Definition Version. The map's keys are input keys, the values are input definition objects."
},
"permissions": {
"type": "array",
"description": "List of [permission short codes](/api/authentication/api-permissions) that the [ephemeral API key](/concepts/building-block/#ephemeral-api-keys) of a Building Block using this version will receive. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"implementation": {
"required": [
"azureDevOpsPipeline",
"githubWorkflows",
"gitlabPipeline",
"terraform",
"type"
],
"type": "object",
"properties": {
"azureDevOpsPipeline": {
"required": [
"async",
"integrationRef",
"pipelineId",
"project"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"project": {
"type": "string",
"description": "The Azure DevOps project containing the pipeline."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced Azure DevOps integration."
}
},
"description": "The reference to the meshIntegration for this Azure DevOps implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use for the Azure DevOps pipeline run.",
"nullable": true
},
"pipelineId": {
"type": "string",
"description": "The ID of the Azure DevOps pipeline to run."
}
},
"description": "Azure DevOps Pipeline Implementation details for this version."
},
"gitlabPipeline": {
"required": [
"integrationRef",
"pipelineTriggerToken",
"projectId",
"refName"
],
"type": "object",
"properties": {
"pipelineTriggerToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The pipeline trigger token used to trigger the GitLab pipeline. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitLab integration."
}
},
"description": "The reference to the meshIntegration for this GitLab implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use."
},
"projectId": {
"type": "string",
"description": "The GitLab project ID containing the pipeline."
}
},
"description": "GitLab Pipeline Implementation details for this version."
},
"terraform": {
"required": [
"async",
"repositoryUrl",
"sshPrivateKey",
"terraformVersion"
],
"type": "object",
"properties": {
"useMeshHttpBackendFallback": {
"type": "boolean",
"description": "Whether to use the Mesh HTTP backend for state storage.",
"nullable": true
},
"terraformVersion": {
"type": "string",
"description": "The version of Terraform / OpenTofu to use."
},
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"sshKnownHost": {
"required": [
"host",
"keyType",
"keyValue"
],
"type": "object",
"properties": {
"keyValue": {
"type": "string",
"description": "The SSH public key value of the Git server."
},
"host": {
"type": "string",
"description": "The hostname of the Git server."
},
"keyType": {
"type": "string",
"description": "The type of the SSH key (e.g., ssh-rsa, ssh-ed25519)."
}
},
"description": "The known host configuration for SSH access to the Git repository."
},
"sshPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "SSH private key used to access the Git repository. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"preRunScript": {
"type": "string",
"description": "An optional shell script (max 16 KiB) executed before each Terraform / OpenTofu run inside the runner container. Use this to perform setup tasks such as installing dependencies or configuring credentials.",
"nullable": true
},
"repositoryPath": {
"type": "string",
"description": "The path within the Git repository to the Terraform / OpenTofu configuration.",
"nullable": true
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use.",
"nullable": true
},
"repositoryUrl": {
"type": "string",
"description": "The URL of the Git repository containing the Terraform / OpenTofu configuration."
}
},
"description": "Terraform / OpenTofu Implementation details for this version."
},
"type": {
"type": "string",
"description": "The type of implementation (, , , , , , , , , )."
},
"githubWorkflows": {
"required": [
"applyWorkflow",
"async",
"branch",
"integrationRef",
"omitRunObjectInput",
"repository"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"destroyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to destroy the building block.",
"nullable": true
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitHub integration."
}
},
"description": "The reference to the meshIntegration for this GitHub implementation."
},
"applyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to apply the building block."
},
"repository": {
"type": "string",
"description": "The GitHub repository containing the workflows."
},
"branch": {
"type": "string",
"description": "The branch of the GitHub repository to use."
},
"omitRunObjectInput": {
"type": "boolean",
"description": "Whether to omit the run object input when triggering the workflow."
}
},
"description": "GitHub Workflows Implementation details for this version."
}
},
"description": "The implementation details of the Building Block Definition Version. The structure of this field depends on the implementation type."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockRunner')."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner."
}
},
"description": "Reference to the Building Block Runner that executes this version."
},
"buildingBlockDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockDefinition')."
},
"uuid": {
"type": "string",
"description": "The UUID of the parent Building Block Definition."
}
},
"description": "Reference to the parent Building Block Definition."
},
"onlyApplyOncePerTenant": {
"type": "boolean",
"description": "Whether this building block can only be applied once per tenant. This is not relevant for Building Blocks on Workspace level."
},
"state": {
"type": "string",
"description": "The state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"dependencyDefinitionUuids": {
"type": "array",
"description": "List of Building Block Definition UUIDs that this version depends on. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"deletionMode": {
"type": "string",
"description": "Specifies how deletion of building blocks based on this version is handled. (One of ['DELETE', 'PURGE'])"
},
"versionNumber": {
"type": "number",
"description": "The version number of this Building Block Definition Version."
}
},
"description": "All fields in this section describe the Building Block Definition Version."
},
"status": {
"required": [
"lifecycle",
"state",
"usageCount"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "The Building Block Definition Version has been marked for deletion at this date (e.g. `2020-12-22T09:37:43Z`). This field is only present if the parent definition is marked for deletion.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the parent Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the version. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition Version has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information including creation and deletion timestamps."
},
"state": {
"type": "string",
"description": "The current state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"usageCount": {
"type": "number",
"description": "The number of building blocks currently using this version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition Version."
}
}
},
"meshCommunicationDefinitionPut": {
"title": "meshCommunicationDefinitionPut",
"type": "object"
},
"meshTenantListV4": {
"title": "meshTenantListV4",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshTenants"
],
"type": "object",
"properties": {
"meshTenants": {
"type": "array",
"description": "List of meshTenants.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshCommunicationPost": {
"title": "meshCommunicationPost",
"type": "object"
},
"api-meshobjectcollections-319085079": {
"required": [
"name",
"owner"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The owner of the meshObjectCollection"
},
"name": {
"type": "string",
"description": "Name of the meshObjectCollection"
}
}
},
"meshPlatform-Post-V2-aks": {
"title": "meshPlatform-Post-V2-aks",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef",
"quotaDefinitions"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"accessInformation": {
"type": "string",
"description": "Optional access information note in Markdown format shown to platform consumers.",
"nullable": true
},
"quotaDefinitions": {
"type": "array",
"description": "List of platform quota definitions. Quota definitions define the available quotas that can be configured for tenants on this platform. Currently only supported for platform types: OPENSHIFT, KUBERNETES, AZURE_KUBERNETES_SERVICE, CLOUDFOUNDRY, OPENSTACK. For unsupported platform types (those not listed above), quota definitions have to be provided as an empty array. For supported platform types, providing an empty array will remove all existing quota definitions of the given platform.",
"items": {
"required": [
"autoApprovalThreshold",
"description",
"label",
"maxValue",
"minValue",
"quotaKey"
],
"type": "object",
"properties": {
"quotaKey": {
"type": "string",
"description": "The key of the quota as it is required by the cloud platform."
},
"minValue": {
"type": "number",
"description": "Minimum allowed value for this quota."
},
"unit": {
"type": "string",
"description": "Unit of measurement for the quota (e.g., 'cores', 'GB', 'requests'). Must match the unit expected by the cloud platform.",
"nullable": true
},
"autoApprovalThreshold": {
"type": "number",
"description": "Threshold below which quota requests are automatically approved."
},
"maxValue": {
"type": "number",
"description": "Maximum allowed value for this quota."
},
"description": {
"type": "string",
"description": "Detailed description of what this quota controls."
},
"label": {
"type": "string",
"description": "Human-readable label for the quota."
}
}
}
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
},
"name": {
"type": "string",
"description": "The identifier of the location."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"publicationState",
"restriction"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"readme": {
"type": "string",
"description": "README about the meshPlatform in markdown format",
"nullable": true
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client config for metering"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Kubernetes configuration, if applicable."
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"gcpRoleMappings",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"serviceAccount",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"gcpRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"gcpRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"gcpRole": {
"type": "string",
"description": "GCP role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP API access"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
},
"metering": {
"required": [
"bigqueryTable",
"partitionTimeColumn",
"processing",
"serviceAccount"
],
"type": "object",
"properties": {
"partitionTimeColumn": {
"type": "string",
"description": "Column name for partitioning time-based data"
},
"additionalFilter": {
"type": "string",
"description": "Additional SQL filter for billing data (optional)",
"nullable": true
},
"bigqueryTableForCarbonFootprint": {
"type": "string",
"description": "BigQuery table containing carbon footprint data (optional)",
"nullable": true
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"carbonFootprintDataCollectionStartMonth": {
"type": "string",
"description": "Start month for carbon footprint data collection (optional)",
"nullable": true
},
"bigqueryTable": {
"type": "string",
"description": "BigQuery table containing billing data export"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account for metering, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider for metering access."
}
},
"description": "Service account workload identity configuration for metering (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for metering service account. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP metering API access"
}
},
"description": "Metering configuration for GCP (optional, but required for metering)"
}
},
"description": "GCP configuration, if applicable."
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Azure Resource Group configuration, if applicable."
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"openshiftRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"openshiftRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"openshiftRole": {
"type": "string",
"description": "OpenShift role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identifier of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Access token for Kubernetes API authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Kubernetes client configuration for metering access"
}
},
"description": "Metering configuration for OpenShift (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"custom": {
"required": [
"platformTypeRef"
],
"type": "object",
"properties": {
"platformTypeRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this ref."
},
"name": {
"type": "string",
"description": "Identifier of the custom platform type"
}
},
"description": "Reference to the specific custom platform type to use"
},
"metering": {
"required": [
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for custom platforms"
}
},
"description": "Custom platform configuration, if applicable."
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of AKS authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator EntraID access to manage groups that are used for RBAC in the AKS cluster."
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the Kubernetes service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"metering": {
"required": [
"clientConfig"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
}
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Replication configuration for AKS (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Azure Kubernetes Service configuration, if applicable."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"accountNamePattern": {
"type": "string",
"description": "Defines the pattern for the AWS account name. If none provided, uses default of '#{workspaceIdentifier}.#{projectIdentifier}'.",
"nullable": true
},
"awsIdentityStore": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"identityStoreId",
"signInUrl"
],
"type": "object",
"properties": {
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign-in URL that end-users must use to log in to the AWS Management Console via AWS IAM Identity Center."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS IAM Identity Center permission set.",
"items": {
"required": [
"awsRole",
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"awsRole": {
"type": "string",
"description": "The name of the AWS role alias used as a suffix in the group name pattern."
},
"permissionSetArns": {
"type": "array",
"description": "The ARNs of the AWS IAM Identity Center permission sets to assign to the group. At least one permission set ARN is required.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
},
"identityStoreId": {
"type": "string",
"description": "The ID of the AWS IAM Identity Center Identity Store associated with this instance. E.g. d-1234567890. You can find this in the AWS IAM Identity Center console."
}
},
"description": "AWS IAM Identity Center integration using the AWS Identity Store API. This is an alternative to the SCIM-based awsSso integration that requires no long-lived SCIM bearer token and is fully compatible with Workload Identity Federation (WIF). Only one of awsSso or awsIdentityStore may be configured at a time. If neither is configured, IAM/group replication is disabled (IAM type 'None')."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later. "
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role. ",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys."
},
"awsSso": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The AWS IAM Identity Center SCIM Access Token. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS role.",
"items": {
"required": [
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration. Configure this to use the legacy SCIM-based IAM integration. Leave both awsSso and awsIdentityStore unset to disable IAM/group replication (IAM type 'None')."
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"metering": {
"required": [
"accessConfig",
"filter",
"processing",
"reservedInstanceFairChargeback",
"savingsPlanFairChargeback"
],
"type": "object",
"properties": {
"filter": {
"type": "string",
"description": "Cost Explorer filter type. NONE includes all costs, EXCLUDE_TAX filters out tax charges."
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role for metering access."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role for metering access via workload identity federation"
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for metering service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for metering service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS metering access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId for enhanced security when assuming the organization root account role for metering.",
"nullable": true
}
},
"description": "AWS access configuration for metering"
},
"savingsPlanFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for savings plans"
},
"reservedInstanceFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for reserved instances"
}
},
"description": "Metering configuration for AWS (optional, but required for metering)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "AWS configuration, if applicable."
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"azureRoleMappings",
"groupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"updateSubscriptionName",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"azureRoleMappings": {
"type": "array",
"description": "Role mappings for Azure with project role references",
"items": {
"required": [
"azureRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRole": {
"required": [
"alias",
"id"
],
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "Alias for the Azure role"
},
"id": {
"type": "string",
"description": "ID of the Azure role"
}
},
"description": "Azure role"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"updateSubscriptionName": {
"type": "boolean",
"description": "Configures whether subscription names should be updated to match the subscription name pattern during replication."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"auth",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure Graph API authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the source service principal for replicator access to a customer agreement. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
},
"metering": {
"required": [
"processing",
"servicePrincipal"
],
"type": "object",
"properties": {
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Client ID of the service principal for metering"
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "Object ID of the service principal for metering"
}
},
"description": "Service principal configuration for metering access"
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for Azure (optional, but required for metering)"
}
},
"description": "Azure configuration, if applicable."
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"availability",
"lifecycle",
"metering"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the platform was deleted. Only present if the platform has been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "Lifecycle state of the platform. Possible values: ACTIVE, DEACTIVATED, MARKED_FOR_DELETION, DELETED."
}
},
"description": "Lifecycle state information of the platform."
},
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"availability": {
"required": [
"publicationState"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace. Possible values: UNPUBLISHED, PUBLISHED, REQUESTED, REJECTED"
}
},
"description": "Marketplace availability and publication status information."
}
},
"description": "Current status information of the meshPlatform."
}
}
},
"meshBuildingBlockRunSourceUpdate": {
"title": "meshBuildingBlockRunSourceUpdate",
"required": [
"runAborted"
],
"type": "object",
"properties": {
"runAborted": {
"type": "boolean",
"description": "DO NOT USE. This response is a known issue and will be fixed in future releases."
}
}
},
"meshPlatform-List-V1": {
"title": "meshPlatform-List-V1",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Contains the self link and pagination links (first, last, next, prev)."
},
"_embedded": {
"required": [
"meshPlatforms"
],
"type": "object",
"properties": {
"meshPlatforms": {
"type": "array",
"description": "List of meshPlatforms with their configurations. Each platform object has the same structure as documented in the GET single platform response.",
"items": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"identifier",
"kind"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the location."
},
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"marketplaceStatus",
"restriction"
],
"type": "object",
"properties": {
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"marketplaceStatus": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"marketPlace",
"metering",
"platform"
],
"type": "object",
"properties": {
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"marketPlace": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Publication status in the marketplace (e.g., PUBLISHED, UNPUBLISHED, REQUESTED, REJECTED)."
}
},
"description": "Marketplace publication status information."
},
"platform": {
"type": "string",
"description": "Lifecycle state of the platform (e.g., ACTIVE, DELETED)."
}
},
"description": "Current status information of the meshPlatform."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshplatformtypes382571989": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshPlatformType."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that owns this platform type."
}
},
"description": "Contains the identifiers for the meshPlatformType."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatformType datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this endpoint."
},
"spec": {
"required": [
"category",
"displayName",
"icon"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshPlatformType shown in the UI."
},
"icon": {
"type": "string",
"description": "The icon used to display the platform type in the UI. This must be provided as a base64 encoded data image. Size should be kept small to ensure fast loading times and efficient storage."
},
"defaultEndpoint": {
"type": "string",
"description": "The default endpoint URL for the platform type. This will be used as a default value when creating platform instances. The default endpoint should be a link to a web portal of the cloud platform for example.",
"nullable": true
},
"category": {
"type": "string",
"description": "The platform category. For custom platform types, this is always 'CUSTOM'. Possible values: OPENSTACK, CLOUDFOUNDRY, SERVICEREGISTRY, AWS, OPENSHIFT, KUBERNETES, AZURE, GCP, AZURE_KUBERNETES_SERVICE, AZURE_RESOURCE_GROUP, CUSTOM, GITHUB."
}
},
"description": "All fields in this section describe the meshPlatformType configuration."
},
"status": {
"required": [
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The lifecycle state of the platform type. Can be 'ACTIVE' or 'DEACTIVATED'. Deactivated platform types cannot be used to create new platform instances."
}
},
"description": "The lifecycle information of the platform type."
}
},
"description": "The current status of the meshPlatformType."
}
}
},
"meshTenantPostV4": {
"title": "meshTenantPostV4",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The identifier of the meshProject the meshTenant belongs to."
},
"markedForDeletionOn": {
"type": "string",
"description": "If the meshTenant has been submitted for deletion by a Workspace Manager, the date is represented here (e.g. `2020-12-22T09:37:43Z)`. Otherwise this field is missing.",
"nullable": true
},
"deletedOn": {
"type": "string",
"description": "If the meshTenant was deleted successfully in the cloud platform, the date is represented here (e.g. `2020-12-22T10:12:25Z)`. Otherwise this field is missing.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The creation date of the meshTenant.",
"nullable": true
},
"uuid": {
"type": "string",
"description": "The UUID of the meshTenant. It must be used to reference a meshTenant.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the meshTenant belongs to."
}
},
"description": "Contains common meshObject data."
},
"apiVersion": {
"type": "string",
"description": "Version of meshTenant datatype. Matches the version provided in the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshTenant' for this endpoint."
},
"spec": {
"required": [
"platformIdentifier",
"quotas"
],
"type": "object",
"properties": {
"quotas": {
"type": "array",
"description": "The set of applied Tenant Quotas. They can be set individually per tenant. By default the Landing Zone quotas are applied to new meshTenants.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"platformTenantId": {
"type": "string",
"description": "The platform tenant id related to this meshTenant. It will only be set if the tenant was either imported via meshObject API with a platformTenantId or if at least one replication run was executed that resulted in the creation of a platform tenant. +\n*Note:* This does not mean the whole replication must have been successful. Some steps like role assignments on this tenant might be still in progress.",
"nullable": true
},
"landingZoneIdentifier": {
"type": "string",
"description": "The identifier of the Landing Zone of this meshTenant. This field will be set for tenants of all platforms except service registries (OSB marketplaces).",
"nullable": true
},
"platformIdentifier": {
"type": "string",
"description": "The identifier of the related platform instance."
}
},
"description": "All fields in this section describe the meshTenant."
},
"status": {
"required": [
"platformTypeIdentifier",
"tags",
"tenantName"
],
"type": "object",
"properties": {
"platformWorkspaceIdentifier": {
"type": "string",
"description": "Some platforms like Cloud Foundry create a representation of a workspace. The identifier of this workspace representation is stored here. This field is not provided or null if the platform does not support this feature.",
"nullable": true
},
"tenantName": {
"type": "string",
"description": "The full name of this tenant, a concatenation of the workspace identifier, project identifier and platform identifier."
},
"tags": {
"type": "object",
"description": "The tags assigned to this meshTenant originating from meshWorkspace, Payment Method and meshProject. Keep in mind, that values are an array."
},
"platformTypeIdentifier": {
"type": "string",
"description": "The identifier of the related platform type."
}
},
"description": "All fields in this section represent the current status of the tenant and can change over time."
}
}
},
"api-meshobjects-meshserviceinstances-serviceInstanceId1565178963": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"instanceId",
"marketplaceIdentifier",
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The project that this Service Instance belongs to."
},
"marketplaceIdentifier": {
"type": "string",
"description": "The identifier of the marketplace that this Service Instance belongs to."
},
"instanceId": {
"type": "string",
"description": "The instance id this Service Instance should use."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that this Service Instance belongs to."
}
},
"description": "Metadata and more fields to identify the Service Instance."
},
"apiVersion": {
"type": "string",
"description": "Version of Service Instance datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"creator",
"displayName",
"planId",
"serviceId"
],
"type": "object",
"properties": {
"creator": {
"type": "string",
"description": "The meshUser's `username` that should be passed to the Open Service Broker via the `X-Broker-API-Originating-Identity` header."
},
"displayName": {
"type": "string",
"description": "The display name of the Service Instance."
},
"planId": {
"type": "string",
"description": "The id of the plan for this Service Instance"
},
"serviceId": {
"type": "string",
"description": "The id of the service for the Service Instance"
},
"parameters": {
"type": "object",
"description": "Parameters to pass to the Service Broker when updating the service instance. The structure and content of this field is defined by the service broker.",
"nullable": true
}
},
"description": "Specifications for the Service Instance."
}
}
},
"meshEventLog": {
"title": "meshEventLog",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"createdAt",
"uuid"
],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "The timestamp when this event log was created (ISO-8601 format)."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies this event log."
}
},
"description": "Contains metadata about the event log, including its UUID and creation timestamp."
},
"apiVersion": {
"type": "string",
"description": "Version of meshEventLog datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshEventLog."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshEventLog' for this endpoint."
},
"spec": {
"required": [
"author",
"content",
"description",
"eventType",
"title"
],
"type": "object",
"properties": {
"author": {
"required": [
"authorType",
"identifier"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the author who triggered this event. Depending on the `authorType`, this is:\n* ApiKey: The Key ID (UUID) of the ApiKey\n* ApiUser: The username of the ApiUser\n* System: Always `system` (only a single System author exists)\n* Unknown: Usually the username of a user that has been deleted\n* User: The `uuid` of the User"
},
"authorType": {
"type": "string",
"description": "The type of author who triggered this event. Possible values: ApiKey, ApiUser, System, Unknown, User."
}
},
"description": "Information about the author who triggered this event."
},
"description": {
"type": "string",
"description": "A detailed description of the event."
},
"previousContent": {
"type": "object",
"description": "The previous content/state before this event occurred, represented as a JSON object. Only present for events of type `Changed`.",
"nullable": true
},
"workspaceRef": {
"type": "object",
"description": "Reference to the workspace this event log is associated with. May be null for system-wide events.",
"nullable": true
},
"eventType": {
"type": "string",
"description": "The type of event. Possible values: Added, Approved, Cancelled, Changed, Created, Deleted, Rejected, Removed, Requested."
},
"title": {
"type": "string",
"description": "A brief title describing the event."
},
"content": {
"type": "object",
"description": "The current content/state associated with this event, represented as a JSON object. The structure varies depending on the event type."
}
},
"description": "All fields in this section describe the event log."
}
}
},
"meshProjectRoleV1Put": {
"title": "meshProjectRoleV1Put",
"type": "object"
},
"meshBuildingBlockDefinitionVersion-list-V1-githubWorkflows": {
"title": "meshBuildingBlockDefinitionVersion-list-V1-githubWorkflows",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshBuildingBlockDefinitionVersions"
],
"type": "object",
"properties": {
"meshBuildingBlockDefinitionVersions": {
"type": "array",
"description": "List of meshBuildingBlockDefinitionVersions.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition Version.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition Version belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition Version. It also contains additional meta information like the version creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition Version datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block Definition Version."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinitionVersion' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionRef",
"deletionMode",
"implementation",
"inputs",
"onlyApplyOncePerTenant",
"outputs",
"runnerRef",
"state",
"versionNumber"
],
"type": "object",
"properties": {
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"type"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable display name for the output."
},
"type": {
"type": "string",
"description": "Data type of the output (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE'])."
},
"assignmentType": {
"type": "string",
"description": "How the output is used (One of ['NONE', 'PLATFORM_TENANT_ID', 'SIGN_IN_URL', 'RESOURCE_URL', 'SUMMARY'])."
}
}
}
},
"description": "Map of output definitions for this Building Block Definition Version. The map's keys are output keys, the values are output definition objects. For manual Building Block Definitions, there must not be any outputs that do not match an input with the same key. For manual Building Block Definitions, the type of outputs must match the one from the input with the same key, but must be translated from SINGLE_SELECT to STRING and from MULTI_SELECT to CODE. "
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"isEnvironment",
"isSensitive",
"type",
"updateableByConsumer"
],
"type": "object",
"properties": {
"argument": {
"type": "object",
"description": "Argument value for the input. Required if assignment type is 'STATIC'\nor 'BUILDING_BLOCK_OUTPUT'.\nFor 'BUILDING_BLOCK_OUTPUT', the value must be a string in the\nformat `.` referencing an output of a parent building block.\nMust match the input type if provided. If input type is 'CODE',\nthe value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of\n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"valueValidationRegex": {
"type": "string",
"description": "Regular expression pattern to validate input values. (optional)",
"nullable": true
},
"defaultValue": {
"type": "object",
"description": "Default value for the input (optional). Must match the input type if provided.\nIf input type is 'CODE', the value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of \n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data that should be encrypted."
},
"displayName": {
"type": "string",
"description": "Human-readable display name for the input."
},
"description": {
"type": "string",
"description": "Description explaining the purpose and usage of the input. (optional)",
"nullable": true
},
"selectableValues": {
"type": "array",
"description": "Set of allowed values for the input in case the type is one of 'SINGLE_SELECT' or 'MULTI_SELECT'. (Must be either null or an empty array.)",
"nullable": true,
"items": {
"type": "string"
}
},
"validationRegexErrorMessage": {
"type": "string",
"description": "Error message to display when regex validation fails. (optional)",
"nullable": true
},
"isEnvironment": {
"type": "boolean",
"description": "Whether this input is exposed as a regular or environment variable."
},
"type": {
"type": "string",
"description": "Data type of the input (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE', 'SINGLE_SELECT', 'MULTI_SELECT'])."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether the input value can be updated by the consumer that does not have admin or platform operator permissions."
},
"assignmentType": {
"type": "string",
"description": "How the input value is assigned (One of ['AUTHOR', 'USER_INPUT', 'PLATFORM_OPERATOR_MANUAL_INPUT', 'BUILDING_BLOCK_OUTPUT', 'PLATFORM_TENANT_ID', 'WORKSPACE_IDENTIFIER', 'PROJECT_IDENTIFIER', 'FULL_PLATFORM_IDENTIFIER', 'TENANT_BUILDING_BLOCK_UUID', 'STATIC', 'USER_PERMISSIONS'])."
}
}
}
},
"description": "Map of input definitions for this Building Block Definition Version. The map's keys are input keys, the values are input definition objects."
},
"permissions": {
"type": "array",
"description": "List of [permission short codes](/api/authentication/api-permissions) that the [ephemeral API key](/concepts/building-block/#ephemeral-api-keys) of a Building Block using this version will receive. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"implementation": {
"type": "object",
"description": "The implementation details of the Building Block Definition Version. The structure of this field depends on the implementation type."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockRunner')."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner."
}
},
"description": "Reference to the Building Block Runner that executes this version."
},
"buildingBlockDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockDefinition')."
},
"uuid": {
"type": "string",
"description": "The UUID of the parent Building Block Definition."
}
},
"description": "Reference to the parent Building Block Definition."
},
"onlyApplyOncePerTenant": {
"type": "boolean",
"description": "Whether this building block can only be applied once per tenant. This is not relevant for Building Blocks on Workspace level."
},
"state": {
"type": "string",
"description": "The state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"dependencyDefinitionUuids": {
"type": "array",
"description": "List of Building Block Definition UUIDs that this version depends on. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"deletionMode": {
"type": "string",
"description": "Specifies how deletion of building blocks based on this version is handled. (One of ['DELETE', 'PURGE'])"
},
"versionNumber": {
"type": "number",
"description": "The version number of this Building Block Definition Version."
}
},
"description": "All fields in this section describe the Building Block Definition Version."
},
"status": {
"required": [
"lifecycle",
"state",
"usageCount"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "The Building Block Definition Version has been marked for deletion at this date (e.g. `2020-12-22T09:37:43Z`). This field is only present if the parent definition is marked for deletion.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the parent Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the version. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition Version has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information including creation and deletion timestamps."
},
"state": {
"type": "string",
"description": "The current state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"usageCount": {
"type": "number",
"description": "The number of building blocks currently using this version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition Version."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshWorkspacePost": {
"title": "meshWorkspacePost",
"type": "object"
},
"api-meshobjects-meshbuildingblockruns-blockRunUuid-status-source-sourceId2076900078": {
"type": "object",
"properties": {
"steps": {
"type": "array",
"description": "Can contain updates to the steps. (Optional)",
"items": {
"required": [
"id"
],
"type": "object",
"properties": {
"outputs": {
"type": "object",
"properties": {
"outputName": {
"required": [
"isSensitive",
"type",
"value"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "object",
"description": "Flag if the variable content is sensitive and encrypted. The runner must decrypt this variable content first before it can be used. Information on how to do this will provided in the future."
},
"type": {
"type": "object",
"description": "The type of the variable. One of STRING, CODE, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "object",
"description": "The name of the input variable."
}
}
}
},
"description": "Contains any output this step has provided. (Optional)"
},
"userMessage": {
"type": "string",
"description": "A message which is displayed to the user. It should not exceed more than 500 characters. (Optional)",
"nullable": true
},
"systemMessage": {
"type": "string",
"description": "A message which is displayed only to the operators. It should not exceed more than 500 characters. (Optional) ",
"nullable": true
},
"id": {
"type": "string",
"description": "The ID of the step which should get updates."
},
"status": {
"type": "string",
"description": "The execution status of this step. Can be `PENDING`, `IN_PROGRESS`, `SUCCEEDED`, `ABORTED` or `FAILED`. (Optional)",
"nullable": true
}
}
}
},
"status": {
"type": "string",
"description": "The execution status of the building block run as whole. Use this to signal termination of the run. Can be any of `PENDING`, `IN_PROGRESS`, `SUCCEEDED`, `ABORTED` or `FAILED`. (Optional)",
"nullable": true
}
}
},
"api-meshobjectcollections1637419709": {
"required": [
"description",
"name",
"owner"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The owner of the meshObjectCollection"
},
"name": {
"type": "string",
"description": "Name of the meshObjectCollection (has to be unique)"
},
"description": {
"type": "string",
"description": "A freetext field to help describing the contents of the meshObjectCollection"
}
}
},
"apiRoot": {
"title": "apiRoot",
"required": [
"_links"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "All available Top-Level Links for the authenticated user."
}
}
},
"meshWorkspaceUserBindingList": {
"title": "meshWorkspaceUserBindingList",
"required": [
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshWorkspaceUserBindings"
],
"type": "object",
"properties": {
"meshWorkspaceUserBindings": {
"type": "array",
"description": "List of meshWorkspaceUserBindings.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshapikeys-uuid-543980870": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID of the API key.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "Identifier of the workspace that owns this API key."
}
},
"description": "Metadata that identifies and scopes the meshApiKey."
},
"apiVersion": {
"type": "string",
"description": "Version of meshApiKey datatype. For this endpoint this is always 'v1-preview'."
},
"kind": {
"type": "string",
"description": "The meshObject kind. For this endpoint this is always 'meshApiKey'."
},
"spec": {
"required": [
"displayName",
"permissions"
],
"type": "object",
"properties": {
"permissions": {
"type": "array",
"description": "Set of permission short-codes assigned to this API key.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"displayName": {
"type": "string",
"description": "Display name of the API key."
},
"expiresAt": {
"type": "string",
"description": "Expiration date of the API key (ISO-8601 date format, e.g. 2025-12-31). Nullable if the key does not expire.",
"nullable": true
}
},
"description": "Configuration of the meshApiKey."
}
}
},
"meshBuildingBlockRunner-Put": {
"title": "meshBuildingBlockRunner-Put",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"lastSeen": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner last connected to meshStack (ISO 8601 format). This is updated automatically whenever the runner polls for work.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner was created (ISO 8601 format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies this meshBuildingBlockRunner. Must not be provided on creation \u2014 meshStack assigns a UUID automatically. On update (PUT), this field is mandatory and must match the UUID in the path parameter.",
"nullable": true
},
"lastKnownVersion": {
"type": "string",
"description": "The last runner version reported via the X-Meshcloud-Runner-Version request header when polling for work. Null if the runner has never sent a version header.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshBuildingBlockRunner."
}
},
"description": "Contains identifying properties of the meshBuildingBlockRunner."
},
"apiVersion": {
"type": "string",
"description": "Version of meshBuildingBlockRunner datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockRunner' for this endpoint."
},
"spec": {
"required": [
"displayName",
"implementationType",
"publicKey"
],
"type": "object",
"properties": {
"implementationType": {
"type": "string",
"description": "The type of building block implementation this runner handles. Possible values: `TERRAFORM`, `GITHUB_WORKFLOW`, `GITLAB_PIPELINE`, `AZURE_DEVOPS_PIPELINE`, `MANUAL`."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of this meshBuildingBlockRunner."
},
"restriction": {
"type": "string",
"description": "Visibility restriction of this runner. `PUBLIC` makes the runner available to all workspaces in meshStack. `PRIVATE` (default) restricts it to the owning workspace. Only administrators can create or update runners with `PUBLIC` restriction.",
"nullable": true
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the GCP federated token, e.g. `/var/run/secrets/workload-identity/gcp/token`."
},
"audience": {
"type": "string",
"description": "The audience for the GCP Workload Identity Federation token, e.g. `//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/my-provider`."
}
},
"description": "GCP-specific Workload Identity Federation configuration for this runner."
},
"subject": {
"type": "string",
"description": "The subject claim of the OIDC token issued to this runner, e.g. `system:serviceaccount:meshfed:my-runner`."
},
"aws": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the AWS federated token, e.g. `/var/run/secrets/workload-identity/aws/token`."
},
"audience": {
"type": "string",
"description": "The audience for the AWS STS AssumeRoleWithWebIdentity call, typically `sts.amazonaws.com`."
},
"thumbprint": {
"type": "string",
"description": "Optional thumbprint of the OIDC provider's root CA certificate for AWS.",
"nullable": true
}
},
"description": "AWS-specific Workload Identity Federation configuration for this runner."
},
"issuer": {
"type": "string",
"description": "The OIDC issuer URL of the identity provider that issues tokens for this runner. This is used to configure trust with the target cloud provider."
},
"azure": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the Azure federated token, e.g. `/var/run/secrets/workload-identity/azure/token`."
},
"audience": {
"type": "string",
"description": "The audience for the Azure federated identity token exchange, typically `api://AzureADTokenExchange`."
}
},
"description": "Azure-specific Workload Identity Federation configuration for this runner."
}
},
"description": "Optional Workload Identity Federation (WIF) configuration for this runner. When configured, the runner can authenticate to cloud providers using short-lived tokens instead of long-lived credentials. At least one of `gcp`, `aws`, or `azure` must be provided."
},
"publicKey": {
"type": "string",
"description": "The RSA public key (PEM-encoded) used to encrypt secrets that are sent to this runner. Accepts either a PEM-encoded public key (BEGIN PUBLIC KEY) or an X.509 certificate (BEGIN CERTIFICATE). The runner uses the corresponding private key to decrypt those secrets at runtime."
},
"isSelfHosted": {
"type": "boolean",
"description": "Indicates whether this runner is self-hosted (deployed and managed by the workspace/customer). `true` for all runners created via this API. `false` for meshcloud-managed platform runners provisioned automatically by meshStack during deployment \u2014 these cannot be created via this API. This field is read-only.",
"nullable": true
}
},
"description": "All fields in this section describe the configuration of the meshBuildingBlockRunner."
}
}
},
"meshBuildingBlockDefinitionVersion-put-V1-azureDevOpsPipeline": {
"title": "meshBuildingBlockDefinitionVersion-put-V1-azureDevOpsPipeline",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition Version.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition Version belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition Version. It also contains additional meta information like the version creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition Version datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block Definition Version."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinitionVersion' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionRef",
"deletionMode",
"implementation",
"inputs",
"onlyApplyOncePerTenant",
"outputs",
"runnerRef",
"state",
"versionNumber"
],
"type": "object",
"properties": {
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"type"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable display name for the output."
},
"type": {
"type": "string",
"description": "Data type of the output (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE'])."
},
"assignmentType": {
"type": "string",
"description": "How the output is used (One of ['NONE', 'PLATFORM_TENANT_ID', 'SIGN_IN_URL', 'RESOURCE_URL', 'SUMMARY'])."
}
}
}
},
"description": "Map of output definitions for this Building Block Definition Version. The map's keys are output keys, the values are output definition objects. For manual Building Block Definitions, there must not be any outputs that do not match an input with the same key. For manual Building Block Definitions, the type of outputs must match the one from the input with the same key, but must be translated from SINGLE_SELECT to STRING and from MULTI_SELECT to CODE. "
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"isEnvironment",
"isSensitive",
"type",
"updateableByConsumer"
],
"type": "object",
"properties": {
"argument": {
"type": "object",
"description": "Argument value for the input. Required if assignment type is 'STATIC'\nor 'BUILDING_BLOCK_OUTPUT'.\nFor 'BUILDING_BLOCK_OUTPUT', the value must be a string in the\nformat `.` referencing an output of a parent building block.\nMust match the input type if provided. If input type is 'CODE',\nthe value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of\n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"valueValidationRegex": {
"type": "string",
"description": "Regular expression pattern to validate input values. (optional)",
"nullable": true
},
"defaultValue": {
"type": "object",
"description": "Default value for the input (optional). Must match the input type if provided.\nIf input type is 'CODE', the value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of \n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data that should be encrypted."
},
"displayName": {
"type": "string",
"description": "Human-readable display name for the input."
},
"description": {
"type": "string",
"description": "Description explaining the purpose and usage of the input. (optional)",
"nullable": true
},
"selectableValues": {
"type": "array",
"description": "Set of allowed values for the input in case the type is one of 'SINGLE_SELECT' or 'MULTI_SELECT'. (Must be either null or an empty array.)",
"nullable": true,
"items": {
"type": "string"
}
},
"validationRegexErrorMessage": {
"type": "string",
"description": "Error message to display when regex validation fails. (optional)",
"nullable": true
},
"isEnvironment": {
"type": "boolean",
"description": "Whether this input is exposed as a regular or environment variable."
},
"type": {
"type": "string",
"description": "Data type of the input (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE', 'SINGLE_SELECT', 'MULTI_SELECT'])."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether the input value can be updated by the consumer that does not have admin or platform operator permissions."
},
"assignmentType": {
"type": "string",
"description": "How the input value is assigned (One of ['AUTHOR', 'USER_INPUT', 'PLATFORM_OPERATOR_MANUAL_INPUT', 'BUILDING_BLOCK_OUTPUT', 'PLATFORM_TENANT_ID', 'WORKSPACE_IDENTIFIER', 'PROJECT_IDENTIFIER', 'FULL_PLATFORM_IDENTIFIER', 'TENANT_BUILDING_BLOCK_UUID', 'STATIC', 'USER_PERMISSIONS'])."
}
}
}
},
"description": "Map of input definitions for this Building Block Definition Version. The map's keys are input keys, the values are input definition objects."
},
"permissions": {
"type": "array",
"description": "List of [permission short codes](/api/authentication/api-permissions) that the [ephemeral API key](/concepts/building-block/#ephemeral-api-keys) of a Building Block using this version will receive. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"implementation": {
"required": [
"azureDevOpsPipeline",
"githubWorkflows",
"gitlabPipeline",
"terraform",
"type"
],
"type": "object",
"properties": {
"azureDevOpsPipeline": {
"required": [
"async",
"integrationRef",
"pipelineId",
"project"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"project": {
"type": "string",
"description": "The Azure DevOps project containing the pipeline."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced Azure DevOps integration."
}
},
"description": "The reference to the meshIntegration for this Azure DevOps implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use for the Azure DevOps pipeline run.",
"nullable": true
},
"pipelineId": {
"type": "string",
"description": "The ID of the Azure DevOps pipeline to run."
}
},
"description": "Azure DevOps Pipeline Implementation details for this version."
},
"gitlabPipeline": {
"required": [
"integrationRef",
"pipelineTriggerToken",
"projectId",
"refName"
],
"type": "object",
"properties": {
"pipelineTriggerToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The pipeline trigger token used to trigger the GitLab pipeline. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitLab integration."
}
},
"description": "The reference to the meshIntegration for this GitLab implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use."
},
"projectId": {
"type": "string",
"description": "The GitLab project ID containing the pipeline."
}
},
"description": "GitLab Pipeline Implementation details for this version."
},
"terraform": {
"required": [
"async",
"repositoryUrl",
"sshPrivateKey",
"terraformVersion"
],
"type": "object",
"properties": {
"useMeshHttpBackendFallback": {
"type": "boolean",
"description": "Whether to use the Mesh HTTP backend for state storage.",
"nullable": true
},
"terraformVersion": {
"type": "string",
"description": "The version of Terraform / OpenTofu to use."
},
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"sshKnownHost": {
"required": [
"host",
"keyType",
"keyValue"
],
"type": "object",
"properties": {
"keyValue": {
"type": "string",
"description": "The SSH public key value of the Git server."
},
"host": {
"type": "string",
"description": "The hostname of the Git server."
},
"keyType": {
"type": "string",
"description": "The type of the SSH key (e.g., ssh-rsa, ssh-ed25519)."
}
},
"description": "The known host configuration for SSH access to the Git repository."
},
"sshPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "SSH private key used to access the Git repository. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"preRunScript": {
"type": "string",
"description": "An optional shell script (max 16 KiB) executed before each Terraform / OpenTofu run inside the runner container. Use this to perform setup tasks such as installing dependencies or configuring credentials.",
"nullable": true
},
"repositoryPath": {
"type": "string",
"description": "The path within the Git repository to the Terraform / OpenTofu configuration.",
"nullable": true
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use.",
"nullable": true
},
"repositoryUrl": {
"type": "string",
"description": "The URL of the Git repository containing the Terraform / OpenTofu configuration."
}
},
"description": "Terraform / OpenTofu Implementation details for this version."
},
"type": {
"type": "string",
"description": "The type of implementation (, , , , , , , , , )."
},
"githubWorkflows": {
"required": [
"applyWorkflow",
"async",
"branch",
"integrationRef",
"omitRunObjectInput",
"repository"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"destroyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to destroy the building block.",
"nullable": true
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitHub integration."
}
},
"description": "The reference to the meshIntegration for this GitHub implementation."
},
"applyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to apply the building block."
},
"repository": {
"type": "string",
"description": "The GitHub repository containing the workflows."
},
"branch": {
"type": "string",
"description": "The branch of the GitHub repository to use."
},
"omitRunObjectInput": {
"type": "boolean",
"description": "Whether to omit the run object input when triggering the workflow."
}
},
"description": "GitHub Workflows Implementation details for this version."
}
},
"description": "The implementation details of the Building Block Definition Version. The structure of this field depends on the implementation type."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockRunner')."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner."
}
},
"description": "Reference to the Building Block Runner that executes this version."
},
"buildingBlockDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockDefinition')."
},
"uuid": {
"type": "string",
"description": "The UUID of the parent Building Block Definition."
}
},
"description": "Reference to the parent Building Block Definition."
},
"onlyApplyOncePerTenant": {
"type": "boolean",
"description": "Whether this building block can only be applied once per tenant. This is not relevant for Building Blocks on Workspace level."
},
"state": {
"type": "string",
"description": "The state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"dependencyDefinitionUuids": {
"type": "array",
"description": "List of Building Block Definition UUIDs that this version depends on. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"deletionMode": {
"type": "string",
"description": "Specifies how deletion of building blocks based on this version is handled. (One of ['DELETE', 'PURGE'])"
},
"versionNumber": {
"type": "number",
"description": "The version number of this Building Block Definition Version."
}
},
"description": "All fields in this section describe the Building Block Definition Version."
},
"status": {
"required": [
"lifecycle",
"state",
"usageCount"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "The Building Block Definition Version has been marked for deletion at this date (e.g. `2020-12-22T09:37:43Z`). This field is only present if the parent definition is marked for deletion.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the parent Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the version. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition Version has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information including creation and deletion timestamps."
},
"state": {
"type": "string",
"description": "The current state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"usageCount": {
"type": "number",
"description": "The number of building blocks currently using this version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition Version."
}
}
},
"meshTagDefinitionPut": {
"title": "meshTagDefinitionPut",
"type": "object"
},
"api-meshobjects-meshbuildingblockdefinitions519685334": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition. It also contains additional meta information like the Building Block Definition creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this endpoint."
},
"spec": {
"required": [
"description",
"displayName",
"targetType",
"useInLandingZonesOnly"
],
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the Building Block Definition as it is shown in meshPanel.",
"nullable": true
},
"documentationUrl": {
"type": "string",
"description": "The URL pointing to documentation of the Building Block Definition. (optional)",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block Definition as it is shown in meshPanel."
},
"supportUrl": {
"type": "string",
"description": "The URL pointing to support of the Building Block Definition. (optional)",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the Building Block Definition as it is shown in meshPanel."
},
"targetType": {
"type": "string",
"description": "The type of Building Block Definition. (One of ['TENANT_LEVEL', 'WORKSPACE_LEVEL'.])"
},
"runTransparency": {
"type": "boolean",
"description": "Specifies the Building Block Definition run control. When set to true, both platform teams and workspace users can view detailed run logs and re-run building blocks. When set to false (default), only platform teams have this access.",
"nullable": true
},
"supportedPlatforms": {
"type": "array",
"description": "Set of the platform types this Building Block Definition supports. Must be non-empty if targetType is 'TENANT_LEVEL', otherwise null. Each entry is a meshPlatformType reference.",
"items": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object. Must be 'meshPlatformType'."
},
"name": {
"type": "string",
"description": "The unique identifier of the platform type (corresponds to the `metadata.name` of a meshPlatformType)."
}
}
}
},
"notificationSubscriberUsernames": {
"type": "array",
"description": "A set of usernames or emails that should be notified as subscribers for this Building Block Definition. Prefix entries with `user:` or `email:`.",
"nullable": true,
"items": {
"type": "string"
}
},
"useInLandingZonesOnly": {
"type": "boolean",
"description": "Indicates whether this Building Block Definition should be used on Landing Zones only."
}
},
"description": "All fields in this section describe the Building Block Definition."
}
}
},
"meshBuildingBlockV2": {
"title": "meshBuildingBlockV2",
"required": [
"_links",
"apiVersion",
"kind",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block and the workspace it belongs to."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionVersionRef",
"displayName",
"inputs",
"parentBuildingBlocks",
"targetRef"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent Building Blocks, which are set on the Building Block.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"targetRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshTenant\""
},
"uuid": {
"type": "string",
"description": "The uuid of the tenant for this Building Block"
}
},
"description": "The reference to either a tenant or workspace the Building Block is located on."
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"updateableByConsumer",
"valueType"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data.",
"nullable": true
},
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether this input can be updated by the consumer."
},
"value": {
"type": "string",
"description": "The value of this input. For sensitive inputs, this is a SecretEmbedded object containing only a 'hash' field (plaintext is never returned in responses).",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the input as defined on the Building Block Definition.",
"nullable": true
}
}
}
},
"description": "Map of input keys to their input data."
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
},
"buildingBlockDefinitionVersionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockDefinitionVersion\""
},
"uuid": {
"type": "string",
"description": "The uuid of the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "The reference to the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "All fields in this section describe the Building Block."
},
"status": {
"required": [
"forcePurge",
"lifecycle",
"outputs",
"status"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the date when a user requested the deletion is provided via this field. e.g. `2020-12-22T09:37:43Z`",
"nullable": true
},
"deletedOn": {
"type": "string",
"description": "If the Building Block has been deleted, the date when it was deleted.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block. ACTIVE, MARKED_FOR_DELETION or DELETED."
},
"createdOn": {
"type": "string",
"description": "The date when the Building Block was created (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
}
},
"description": "Lifecycle information of the Building Block."
},
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value of this output.",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the output as defined on the Building Block Definition. One of NONE, PLATFORM_TENANT_ID, SIGN_IN_URL, RESOURCE_URL, SUMMARY.",
"nullable": true
}
}
}
},
"description": "Map of output keys to their output data."
},
"forcePurge": {
"type": "boolean",
"description": "Indicates whether this building block was marked to be purged."
},
"latestRunUuid": {
"type": "string",
"description": "The UUID of the latest meshBuildingBlockRun for this Building Block. This field is null when the caller's permissions are not sufficient to view runs \u2014 for example, when the API key has workspace-scoped access only and the Building Block Definition does not have run transparency enabled.",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
},
"description": "All fields in this section describe the current status of the Building Block."
}
}
},
"meshBuildingBlockRetriggerRun": {
"title": "meshBuildingBlockRetriggerRun",
"required": [
"_links",
"apiVersion",
"kind",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block and the workspace it belongs to."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionVersionRef",
"displayName",
"inputs",
"parentBuildingBlocks",
"targetRef"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent Building Blocks, which are set on the Building Block.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"targetRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshTenant\""
},
"uuid": {
"type": "string",
"description": "The uuid of the tenant for this Building Block"
}
},
"description": "The reference to either a tenant or workspace the Building Block is located on."
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"updateableByConsumer",
"valueType"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data.",
"nullable": true
},
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether this input can be updated by the consumer."
},
"value": {
"type": "string",
"description": "The value of this input. For sensitive inputs, this is a SecretEmbedded object containing only a 'hash' field (plaintext is never returned in responses).",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the input as defined on the Building Block Definition.",
"nullable": true
}
}
}
},
"description": "Map of input keys to their input data."
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
},
"buildingBlockDefinitionVersionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockDefinitionVersion\""
},
"uuid": {
"type": "string",
"description": "The uuid of the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "The reference to the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "All fields in this section describe the Building Block."
},
"status": {
"required": [
"forcePurge",
"lifecycle",
"outputs",
"status"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the date when a user requested the deletion is provided via this field. e.g. `2020-12-22T09:37:43Z`",
"nullable": true
},
"deletedOn": {
"type": "string",
"description": "If the Building Block has been deleted, the date when it was deleted.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block. ACTIVE, MARKED_FOR_DELETION or DELETED."
},
"createdOn": {
"type": "string",
"description": "The date when the Building Block was created (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
}
},
"description": "Lifecycle information of the Building Block."
},
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value of this output.",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the output as defined on the Building Block Definition. One of NONE, PLATFORM_TENANT_ID, SIGN_IN_URL, RESOURCE_URL, SUMMARY.",
"nullable": true
}
}
}
},
"description": "Map of output keys to their output data."
},
"forcePurge": {
"type": "boolean",
"description": "Indicates whether this building block was marked to be purged."
},
"latestRunUuid": {
"type": "string",
"description": "The UUID of the latest meshBuildingBlockRun for this Building Block. This field is null when the caller's permissions are not sufficient to view runs \u2014 for example, when the API key has workspace-scoped access only and the Building Block Definition does not have run transparency enabled.",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
},
"description": "All fields in this section describe the current status of the Building Block."
}
}
},
"meshPlatform-Put-V1-aws": {
"title": "meshPlatform-Put-V1-aws",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"identifier",
"kind"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the location."
},
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"marketplaceStatus",
"restriction"
],
"type": "object",
"properties": {
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"marketplaceStatus": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for Kubernetes"
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"roleMappings",
"serviceAccountConfig",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"serviceAccountConfig": {
"type": "object",
"properties": {
"serviceAccountCredentialsConfig": {
"required": [
"serviceAccountCredentialsB64"
],
"type": "object",
"properties": {
"serviceAccountCredentialsB64": {
"type": "string",
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. The replicator uses this Service Account to automate GCP API operations (IAM, ResourceManager etc.)."
}
},
"description": "Service account credentials configuration (alternative to serviceAccountWorkloadIdentityConfig)"
},
"serviceAccountWorkloadIdentityConfig": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (alternative to serviceAccountCredentialsConfig)"
}
},
"description": "Service account configuration. Either serviceAccountCredentialsConfig or serviceAccountWorkloadIdentityConfig must be provided."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for GCP"
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application"
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure Resource Group"
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for OpenShift"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret for the service principal (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type for the service principal (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for AKS"
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Configuration for Azure Kubernetes Service (AKS)"
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"workloadIdentityConfig": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (alternative to serviceUserConfig)"
},
"serviceUserConfig": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "string",
"description": "AWS secret key for service user"
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user configuration (alternative to workloadIdentityConfig)"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role.",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys. Either the `serviceUserConfig` or `workloadIdentityConfig` must be provided."
},
"awsSso": {
"required": [
"arn",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "string",
"description": "The AWS IAM Identity Center SCIM Access Token that was generated via the Automatic provisioning config in AWS IAM Identity Center."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"roleMappings": {
"type": "object",
"properties": {
"member": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for member role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for member role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"admin": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for admin role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for admin role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"description": "Role mappings for AWS SSO"
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration"
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "Configuration for AWS"
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"groupNamePattern",
"roleMappings",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"roleMappings": {
"type": "object",
"description": "Role mappings for Azure"
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"authType",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Must be set if and only if `authType` is `CREDENTIALS`. A valid secret for accessing the application. In Azure Portal, this can be configured on the \"App Registration\" under Certificates & secrets. https://docs.meshcloud.io/operations/security-faq/#how-does-meshstack-securely-handle-my-cloud-platform-credentials[How is this information secured?]",
"nullable": true
},
"authType": {
"type": "string",
"description": "Must be one of `CREDENTIALS` or `WORKLOAD_IDENTITY`. Workload Identity Federation is the one that we recommend as it enables the most secure approach to provide access to your Azure tenant without using long lived credentials. Credential Authentication is an alternative approach where you have to provide a clientSecret manually to meshStack and meshStack stores it encrypted."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure"
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"marketPlace",
"metering",
"platform"
],
"type": "object",
"properties": {
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"marketPlace": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Publication status in the marketplace (e.g., PUBLISHED, UNPUBLISHED, REQUESTED, REJECTED)."
}
},
"description": "Marketplace publication status information."
},
"platform": {
"type": "string",
"description": "Lifecycle state of the platform (e.g., ACTIVE, DELETED)."
}
},
"description": "Current status information of the meshPlatform."
}
}
},
"meshPlatform-Post-V1-aks": {
"title": "meshPlatform-Post-V1-aks",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"identifier",
"kind"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the location."
},
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"marketplaceStatus",
"restriction"
],
"type": "object",
"properties": {
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"marketplaceStatus": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for Kubernetes"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application"
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure Resource Group"
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"roleMappings",
"serviceAccountConfig",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"serviceAccountConfig": {
"type": "object",
"properties": {
"serviceAccountCredentialsConfig": {
"required": [
"serviceAccountCredentialsB64"
],
"type": "object",
"properties": {
"serviceAccountCredentialsB64": {
"type": "string",
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. The replicator uses this Service Account to automate GCP API operations (IAM, ResourceManager etc.)."
}
},
"description": "Service account credentials configuration (alternative to serviceAccountWorkloadIdentityConfig)"
},
"serviceAccountWorkloadIdentityConfig": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (alternative to serviceAccountCredentialsConfig)"
}
},
"description": "Service account configuration. Either serviceAccountCredentialsConfig or serviceAccountWorkloadIdentityConfig must be provided."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for GCP"
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for OpenShift"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret for the service principal (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type for the service principal (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for AKS"
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Configuration for Azure Kubernetes Service (AKS)"
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"workloadIdentityConfig": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (alternative to serviceUserConfig)"
},
"serviceUserConfig": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "string",
"description": "AWS secret key for service user"
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user configuration (alternative to workloadIdentityConfig)"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role.",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys. Either the `serviceUserConfig` or `workloadIdentityConfig` must be provided."
},
"awsSso": {
"required": [
"arn",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "string",
"description": "The AWS IAM Identity Center SCIM Access Token that was generated via the Automatic provisioning config in AWS IAM Identity Center."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"roleMappings": {
"type": "object",
"properties": {
"member": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for member role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for member role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"admin": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for admin role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for admin role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"description": "Role mappings for AWS SSO"
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration"
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "Configuration for AWS"
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"groupNamePattern",
"roleMappings",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"roleMappings": {
"type": "object",
"description": "Role mappings for Azure"
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"authType",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Must be set if and only if `authType` is `CREDENTIALS`. A valid secret for accessing the application. In Azure Portal, this can be configured on the \"App Registration\" under Certificates & secrets. https://docs.meshcloud.io/operations/security-faq/#how-does-meshstack-securely-handle-my-cloud-platform-credentials[How is this information secured?]",
"nullable": true
},
"authType": {
"type": "string",
"description": "Must be one of `CREDENTIALS` or `WORKLOAD_IDENTITY`. Workload Identity Federation is the one that we recommend as it enables the most secure approach to provide access to your Azure tenant without using long lived credentials. Credential Authentication is an alternative approach where you have to provide a clientSecret manually to meshStack and meshStack stores it encrypted."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure"
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"marketPlace",
"metering",
"platform"
],
"type": "object",
"properties": {
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"marketPlace": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Publication status in the marketplace (e.g., PUBLISHED, UNPUBLISHED, REQUESTED, REJECTED)."
}
},
"description": "Marketplace publication status information."
},
"platform": {
"type": "string",
"description": "Lifecycle state of the platform (e.g., ACTIVE, DELETED)."
}
},
"description": "Current status information of the meshPlatform."
}
}
},
"meshPlatformTypeV1": {
"title": "meshPlatformTypeV1",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshPlatformType."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshPlatformType across all platform types.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that owns this platform type."
}
},
"description": "Contains the identifiers for the meshPlatformType."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatformType datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshPlatformType."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this endpoint."
},
"spec": {
"required": [
"category",
"displayName",
"icon"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshPlatformType shown in the UI."
},
"icon": {
"type": "string",
"description": "The icon used to display the platform type in the UI. This must be provided as a base64 encoded data image. Size should be kept small to ensure fast loading times and efficient storage."
},
"defaultEndpoint": {
"type": "string",
"description": "The default endpoint URL for the platform type. This will be used as a default value when creating platform instances. The default endpoint should be a link to a web portal of the cloud platform for example.",
"nullable": true
},
"category": {
"type": "string",
"description": "The platform category. For custom platform types, this is always 'CUSTOM'. Possible values: OPENSTACK, CLOUDFOUNDRY, SERVICEREGISTRY, AWS, OPENSHIFT, KUBERNETES, AZURE, GCP, AZURE_KUBERNETES_SERVICE, AZURE_RESOURCE_GROUP, CUSTOM, GITHUB."
}
},
"description": "All fields in this section describe the meshPlatformType configuration."
},
"status": {
"required": [
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The lifecycle state of the platform type. Can be 'ACTIVE' or 'DEACTIVATED'. Deactivated platform types cannot be used to create new platform instances."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the meshPlatformType was created.",
"nullable": true
}
},
"description": "The lifecycle information of the platform type."
}
},
"description": "The current status of the meshPlatformType."
}
}
},
"meshTagDefinitionList": {
"title": "meshTagDefinitionList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshTagDefinitions"
],
"type": "object",
"properties": {
"meshTagDefinitions": {
"type": "array",
"description": "List of meshTagDefinitions.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshplatforms-1654402271": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"identifier",
"kind"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the location."
},
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"marketplaceStatus",
"restriction"
],
"type": "object",
"properties": {
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"marketplaceStatus": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for Kubernetes"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application"
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure Resource Group"
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"roleMappings",
"serviceAccountConfig",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"serviceAccountConfig": {
"type": "object",
"properties": {
"serviceAccountCredentialsConfig": {
"required": [
"serviceAccountCredentialsB64"
],
"type": "object",
"properties": {
"serviceAccountCredentialsB64": {
"type": "string",
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. The replicator uses this Service Account to automate GCP API operations (IAM, ResourceManager etc.)."
}
},
"description": "Service account credentials configuration (alternative to serviceAccountWorkloadIdentityConfig)"
},
"serviceAccountWorkloadIdentityConfig": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (alternative to serviceAccountCredentialsConfig)"
}
},
"description": "Service account configuration. Either serviceAccountCredentialsConfig or serviceAccountWorkloadIdentityConfig must be provided."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for GCP"
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for OpenShift"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret for the service principal (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type for the service principal (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for AKS"
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Configuration for Azure Kubernetes Service (AKS)"
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"workloadIdentityConfig": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (alternative to serviceUserConfig)"
},
"serviceUserConfig": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "string",
"description": "AWS secret key for service user"
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user configuration (alternative to workloadIdentityConfig)"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role.",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys. Either the `serviceUserConfig` or `workloadIdentityConfig` must be provided."
},
"awsSso": {
"required": [
"arn",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "string",
"description": "The AWS IAM Identity Center SCIM Access Token that was generated via the Automatic provisioning config in AWS IAM Identity Center."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"roleMappings": {
"type": "object",
"properties": {
"member": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for member role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for member role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"admin": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for admin role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for admin role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"description": "Role mappings for AWS SSO"
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration"
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "Configuration for AWS"
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"groupNamePattern",
"roleMappings",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"roleMappings": {
"type": "object",
"description": "Role mappings for Azure"
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"authType",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Must be set if and only if `authType` is `CREDENTIALS`. A valid secret for accessing the application. In Azure Portal, this can be configured on the \"App Registration\" under Certificates & secrets. https://docs.meshcloud.io/operations/security-faq/#how-does-meshstack-securely-handle-my-cloud-platform-credentials[How is this information secured?]",
"nullable": true
},
"authType": {
"type": "string",
"description": "Must be one of `CREDENTIALS` or `WORKLOAD_IDENTITY`. Workload Identity Federation is the one that we recommend as it enables the most secure approach to provide access to your Azure tenant without using long lived credentials. Credential Authentication is an alternative approach where you have to provide a clientSecret manually to meshStack and meshStack stores it encrypted."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure"
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
}
}
},
"api-meshobjects-meshlocations-1689823740": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshLocation."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this location."
}
},
"description": "Contains the identifiers for the meshLocation."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLocation datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLocation' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshLocation shown in the UI."
},
"description": {
"type": "string",
"description": "An optional description of the meshLocation.",
"nullable": true
}
},
"description": "All fields in this section describe the meshLocation configuration."
}
}
},
"meshWorkspaceGroupBindingCreate": {
"title": "meshWorkspaceGroupBindingCreate",
"required": [
"_links",
"apiVersion",
"kind",
"metadata"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the workspace the group is assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the workspace the group is assigned to."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The meshWorkspaceGroupBinding identifier as 'name' to uniquely identify the meshWorkspaceGroupBinding."
}
},
"description": "Always contains the 'name' to uniquely identify the meshWorkspaceGroupBinding."
},
"apiVersion": {
"type": "string",
"description": "Version of meshWorkspaceGroupBinding datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of this workspace user group."
}
}
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshWorkspaceGroupBinding' for this endpoint."
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this group."
}
}
}
}
},
"api-meshobjects-meshworkspaces-1513610107": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"tags"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The workspaceIdentifier as 'name' to uniquely identify the meshWorkspace. (readonly after creation)"
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshWorkspace. Keep in mind, that values are an array. You must always provide all the tags of the workspace inside this object. If you provide an empty object, the tags will be removed from your workspace."
}
},
"description": "Always contains the 'name' to uniquely identify the meshWorkspace."
},
"apiVersion": {
"type": "string",
"description": "Version of meshWorkspace datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshWorkspace' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"platformBuilderAccessEnabled": {
"type": "boolean",
"description": "When enabled, you can open the platform builder at the top right of your screen when you visit the workspace in the panel.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshWorkspace as it is shown in meshPanel."
}
},
"description": "All fields in this section describe the meshWorkspace."
}
}
},
"meshPaymentMethodV2Post": {
"title": "meshPaymentMethodV2Post",
"type": "object"
},
"api-meshobjects-meshbuildingblockdefinitionversions2142249952": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition Version belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition Version. It also contains additional meta information like the version creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition Version datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinitionVersion' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionRef",
"deletionMode",
"implementation",
"inputs",
"onlyApplyOncePerTenant",
"outputs",
"runnerRef",
"state",
"versionNumber"
],
"type": "object",
"properties": {
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"type"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable display name for the output."
},
"type": {
"type": "string",
"description": "Data type of the output (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE'])."
},
"assignmentType": {
"type": "string",
"description": "How the output is used (One of ['NONE', 'PLATFORM_TENANT_ID', 'SIGN_IN_URL', 'RESOURCE_URL', 'SUMMARY'])."
}
}
}
},
"description": "Map of output definitions for this Building Block Definition Version. The map's keys are output keys, the values are output definition objects. For manual Building Block Definitions, there must not be any outputs that do not match an input with the same key. For manual Building Block Definitions, the type of outputs must match the one from the input with the same key, but must be translated from SINGLE_SELECT to STRING and from MULTI_SELECT to CODE. "
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"isEnvironment",
"isSensitive",
"type",
"updateableByConsumer"
],
"type": "object",
"properties": {
"argument": {
"type": "object",
"description": "Argument value for the input. Required if assignment type is 'STATIC'\nor 'BUILDING_BLOCK_OUTPUT'.\nFor 'BUILDING_BLOCK_OUTPUT', the value must be a string in the\nformat `.` referencing an output of a parent building block.\nMust match the input type if provided. If input type is 'CODE',\nthe value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of\n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"valueValidationRegex": {
"type": "string",
"description": "Regular expression pattern to validate input values. (optional)",
"nullable": true
},
"defaultValue": {
"type": "object",
"description": "Default value for the input (optional). Must match the input type if provided.\nIf input type is 'CODE', the value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of \n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data that should be encrypted."
},
"displayName": {
"type": "string",
"description": "Human-readable display name for the input."
},
"description": {
"type": "string",
"description": "Description explaining the purpose and usage of the input. (optional)",
"nullable": true
},
"selectableValues": {
"type": "array",
"description": "Set of allowed values for the input in case the type is one of 'SINGLE_SELECT' or 'MULTI_SELECT'. (Must be either null or an empty array.)",
"nullable": true,
"items": {
"type": "string"
}
},
"validationRegexErrorMessage": {
"type": "string",
"description": "Error message to display when regex validation fails. (optional)",
"nullable": true
},
"isEnvironment": {
"type": "boolean",
"description": "Whether this input is exposed as a regular or environment variable."
},
"type": {
"type": "string",
"description": "Data type of the input (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE', 'SINGLE_SELECT', 'MULTI_SELECT'])."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether the input value can be updated by the consumer that does not have admin or platform operator permissions."
},
"assignmentType": {
"type": "string",
"description": "How the input value is assigned (One of ['AUTHOR', 'USER_INPUT', 'PLATFORM_OPERATOR_MANUAL_INPUT', 'BUILDING_BLOCK_OUTPUT', 'PLATFORM_TENANT_ID', 'WORKSPACE_IDENTIFIER', 'PROJECT_IDENTIFIER', 'FULL_PLATFORM_IDENTIFIER', 'TENANT_BUILDING_BLOCK_UUID', 'STATIC', 'USER_PERMISSIONS'])."
}
}
}
},
"description": "Map of input definitions for this Building Block Definition Version. The map's keys are input keys, the values are input definition objects."
},
"permissions": {
"type": "array",
"description": "List of [permission short codes](/api/authentication/api-permissions) that the [ephemeral API key](/concepts/building-block/#ephemeral-api-keys) of a Building Block using this version will receive. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"implementation": {
"required": [
"azureDevOpsPipeline",
"githubWorkflows",
"gitlabPipeline",
"terraform",
"type"
],
"type": "object",
"properties": {
"azureDevOpsPipeline": {
"required": [
"async",
"integrationRef",
"pipelineId",
"project"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"project": {
"type": "string",
"description": "The Azure DevOps project containing the pipeline."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced Azure DevOps integration."
}
},
"description": "The reference to the meshIntegration for this Azure DevOps implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use for the Azure DevOps pipeline run.",
"nullable": true
},
"pipelineId": {
"type": "string",
"description": "The ID of the Azure DevOps pipeline to run."
}
},
"description": "Azure DevOps Pipeline Implementation details for this version."
},
"gitlabPipeline": {
"required": [
"integrationRef",
"pipelineTriggerToken",
"projectId",
"refName"
],
"type": "object",
"properties": {
"pipelineTriggerToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The pipeline trigger token used to trigger the GitLab pipeline. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitLab integration."
}
},
"description": "The reference to the meshIntegration for this GitLab implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use."
},
"projectId": {
"type": "string",
"description": "The GitLab project ID containing the pipeline."
}
},
"description": "GitLab Pipeline Implementation details for this version."
},
"terraform": {
"required": [
"async",
"repositoryUrl",
"sshPrivateKey",
"terraformVersion"
],
"type": "object",
"properties": {
"useMeshHttpBackendFallback": {
"type": "boolean",
"description": "Whether to use the Mesh HTTP backend for state storage.",
"nullable": true
},
"terraformVersion": {
"type": "string",
"description": "The version of Terraform / OpenTofu to use."
},
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"sshKnownHost": {
"required": [
"host",
"keyType",
"keyValue"
],
"type": "object",
"properties": {
"keyValue": {
"type": "string",
"description": "The SSH public key value of the Git server."
},
"host": {
"type": "string",
"description": "The hostname of the Git server."
},
"keyType": {
"type": "string",
"description": "The type of the SSH key (e.g., ssh-rsa, ssh-ed25519)."
}
},
"description": "The known host configuration for SSH access to the Git repository."
},
"sshPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "SSH private key used to access the Git repository. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"preRunScript": {
"type": "string",
"description": "An optional shell script (max 16 KiB) executed before each Terraform / OpenTofu run inside the runner container. Use this to perform setup tasks such as installing dependencies or configuring credentials.",
"nullable": true
},
"repositoryPath": {
"type": "string",
"description": "The path within the Git repository to the Terraform / OpenTofu configuration.",
"nullable": true
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use.",
"nullable": true
},
"repositoryUrl": {
"type": "string",
"description": "The URL of the Git repository containing the Terraform / OpenTofu configuration."
}
},
"description": "Terraform / OpenTofu Implementation details for this version."
},
"githubWorkflows": {
"required": [
"applyWorkflow",
"async",
"branch",
"integrationRef",
"omitRunObjectInput",
"repository"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"destroyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to destroy the building block.",
"nullable": true
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitHub integration."
}
},
"description": "The reference to the meshIntegration for this GitHub implementation."
},
"applyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to apply the building block."
},
"repository": {
"type": "string",
"description": "The GitHub repository containing the workflows."
},
"branch": {
"type": "string",
"description": "The branch of the GitHub repository to use."
},
"omitRunObjectInput": {
"type": "boolean",
"description": "Whether to omit the run object input when triggering the workflow."
}
},
"description": "GitHub Workflows Implementation details for this version."
},
"type": {
"type": "string",
"description": "The type of implementation (, , , , , , , , , )."
}
},
"description": "The implementation details of the Building Block Definition Version. The structure of this field depends on the implementation type."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockRunner')."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner."
}
},
"description": "Reference to the Building Block Runner that executes this version."
},
"buildingBlockDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockDefinition')."
},
"uuid": {
"type": "string",
"description": "The UUID of the parent Building Block Definition."
}
},
"description": "Reference to the parent Building Block Definition."
},
"onlyApplyOncePerTenant": {
"type": "boolean",
"description": "Whether this building block can only be applied once per tenant. This is not relevant for Building Blocks on Workspace level."
},
"state": {
"type": "string",
"description": "The state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"dependencyDefinitionUuids": {
"type": "array",
"description": "List of Building Block Definition UUIDs that this version depends on. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"deletionMode": {
"type": "string",
"description": "Specifies how deletion of building blocks based on this version is handled. (One of ['DELETE', 'PURGE'])"
},
"versionNumber": {
"type": "number",
"description": "The version number of this Building Block Definition Version."
}
},
"description": "All fields in this section describe the Building Block Definition Version."
}
}
},
"api-login-582311654": {
"required": [
"clientId",
"clientSecret"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Key ID assigned to your API key upon creation. This ID is used to authenticate your application."
},
"clientSecret": {
"type": "string",
"description": "The Key Secret associated with your API key. This secret is used in conjunction with the `clientId` to securely authenticate your application."
}
}
},
"api-meshobjects-meshbuildingblocks-uuid-836471433": {
"required": [
"apiVersion",
"kind",
"spec"
],
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionVersionRef",
"displayName",
"inputs",
"parentBuildingBlocks",
"targetRef"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent Building Blocks, which are required for the Building Block. If none given, an empty list needs to be provided.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"targetRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshTenant\""
},
"uuid": {
"type": "string",
"description": "The uuid of the tenant for this Building Block"
}
},
"description": "The reference to either a tenant or workspace the Building Block is located on."
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value of this input. For sensitive inputs, this is a SecretEmbedded object containing only a 'hash' field (plaintext is never returned in responses).",
"nullable": true
}
}
}
},
"description": "Map of input keys to their input data."
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
},
"buildingBlockDefinitionVersionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockDefinitionVersion\""
},
"uuid": {
"type": "string",
"description": "The uuid of the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "The reference to the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "All fields in this section describe the Building Block."
}
}
},
"meshWorkspaceUserGroupList": {
"title": "meshWorkspaceUserGroupList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshWorkspaceUserGroups"
],
"type": "object",
"properties": {
"meshWorkspaceUserGroups": {
"type": "array",
"description": "List of meshWorkspaceUserGroups.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshprojectbindings-userbindings226655957": {
"required": [
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the project the user should get assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of this binding which later can be used to refer to it"
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of this object"
},
"kind": {
"type": "string",
"description": "Type of the returned meshObject"
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username of the referenced user."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this user."
}
}
}
}
},
"meshObjectsRootV2": {
"title": "meshObjectsRootV2",
"required": [
"_links"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "All available meshObject Links for the authenticated user."
}
}
},
"meshProjectUserBindingV3": {
"title": "meshProjectUserBindingV3",
"required": [
"_links",
"apiVersion",
"kind",
"metadata"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the project the user is assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the project the user is assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The meshProjectUserBinding identifier as 'name' to uniquely identify the meshProjectUserBinding."
}
},
"description": "Always contains the 'name' to uniquely identify the meshProjectUserBinding."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProjectUserBinding datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username of the referenced user."
}
}
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectUserBinding' for this endpoint."
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this user."
}
}
}
}
},
"api-meshobjects-meshbuildingblockruns-blockRunUuid-status-source-1604577785": {
"required": [
"steps"
],
"type": "object",
"properties": {
"source": {
"required": [
"id"
],
"type": "object",
"properties": {
"externalRunId": {
"type": "string",
"description": "In case the external run is tracked by a different ID you can include it here",
"nullable": true
},
"externalRunUrl": {
"type": "string",
"description": "You can provide a clickable URL to a website with additional information about the external run.",
"nullable": true
},
"id": {
"type": "string",
"description": "The ID of this source."
}
}
},
"steps": {
"type": "array",
"description": "Contains the steps for this source. It should not exceed more than 50 steps",
"items": {
"required": [
"displayName",
"id"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The human readable display name of the step"
},
"id": {
"type": "string",
"description": "The ID of this step."
},
"status": {
"type": "string",
"description": "The execution status of this step. Can be `PENDING`, `IN_PROGRESS`, `SUCCEEDED` or `FAILED`.",
"nullable": true
}
}
}
}
}
},
"meshBuildingBlockRunList": {
"title": "meshBuildingBlockRunList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Contains the self link and pagination links (first, last, next, prev)."
},
"_embedded": {
"required": [
"meshBuildingBlockRuns"
],
"type": "object",
"properties": {
"meshBuildingBlockRuns": {
"type": "array",
"description": "List of meshBuildingBlockRuns.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshtenants-1377394246": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByProject",
"ownedByWorkspace",
"platformIdentifier"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The identifier of the meshProject the meshTenant belongs to."
},
"platformIdentifier": {
"type": "string",
"description": "The identifier of the platform the meshTenant belongs to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the meshTenant belongs to."
}
},
"description": "Fixed fields that help identify the Tenant."
},
"apiVersion": {
"type": "string",
"description": "Version of Tenant datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshTenant' for this endpoint."
},
"spec": {
"required": [
"landingZoneIdentifier"
],
"type": "object",
"properties": {
"landingZoneIdentifier": {
"type": "string",
"description": "The identifier of the landing zone the meshTenant belongs to."
},
"localId": {
"type": "string",
"description": "The localId (platform tenant id) assigned by the platform for this meshTenant. If set, meshStack will import an existing tenant from the cloud platform instead of creating a new one. Only API Keys or API Users with admin permissions for saving tenants can set this field.",
"nullable": true
}
},
"description": "All fields in this section describe the Tenant."
}
}
},
"meshBuildingBlockList": {
"title": "meshBuildingBlockList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Contains the self link and pagination links (first, last, next, prev). Also includes a link to the related tenant."
},
"_embedded": {
"required": [
"meshBuildingBlocks"
],
"type": "object",
"properties": {
"meshBuildingBlocks": {
"type": "array",
"description": "List of meshBuildingBlocks.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshUserListV2": {
"title": "meshUserListV2",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshUsers"
],
"type": "object",
"properties": {
"meshUsers": {
"type": "array",
"description": "List of meshUsers.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username as 'name' to uniquely identify the meshUser."
},
"uuid": {
"type": "string",
"description": "A unique identifier (UUID) for the meshUser.",
"nullable": true
}
},
"description": "Always contains the 'name' to uniquely identify the meshUser."
},
"apiVersion": {
"type": "string",
"description": "Version of meshUser datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshUser."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshUser' for this endpoint."
},
"spec": {
"required": [
"email",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"lastName": {
"type": "string",
"description": "The last name of the meshUser."
},
"firstName": {
"type": "string",
"description": "The first name of the meshUser."
},
"euid": {
"type": "string",
"description": "External User ID which is used to lookup the user in the cloud platforms.",
"nullable": true
},
"email": {
"type": "string",
"description": "The email of the meshUser."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshUser. Keep in mind, that values are an array.",
"nullable": true
}
},
"description": "All fields in this section describe the meshUser."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshWorkspaceUserBindingCreate": {
"title": "meshWorkspaceUserBindingCreate",
"required": [
"_links",
"apiVersion",
"kind",
"metadata"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the workspace the user is assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the workspace the user is assigned to."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The meshWorkspaceUserBinding identifier as 'name' to uniquely identify the meshWorkspaceUserBinding."
}
},
"description": "Always contains the 'name' to uniquely identify the meshWorkspaceUserBinding."
},
"apiVersion": {
"type": "string",
"description": "Version of meshWorkspaceUserBinding datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username of the referenced user."
}
}
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshWorkspaceUserBinding' for this endpoint."
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this user."
}
}
}
}
},
"meshProjectGroupBindingCreateV3": {
"title": "meshProjectGroupBindingCreateV3",
"required": [
"_links",
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the project the group should get assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the project the group should get assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of this binding which later can be used to refer to it"
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of this object"
},
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"kind": {
"type": "string",
"description": "Type of the returned meshObject"
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the referenced group."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this group."
}
}
}
}
},
"meshBuildingBlockPutV2": {
"title": "meshBuildingBlockPutV2",
"required": [
"_links",
"apiVersion",
"kind",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block and the workspace it belongs to."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionVersionRef",
"displayName",
"inputs",
"parentBuildingBlocks",
"targetRef"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent Building Blocks, which are set on the Building Block.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"targetRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshTenant\""
},
"uuid": {
"type": "string",
"description": "The uuid of the tenant for this Building Block"
}
},
"description": "The reference to either a tenant or workspace the Building Block is located on."
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"updateableByConsumer",
"valueType"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data.",
"nullable": true
},
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether this input can be updated by the consumer."
},
"value": {
"type": "string",
"description": "The value of this input. For sensitive inputs, this is a SecretEmbedded object containing only a 'hash' field (plaintext is never returned in responses).",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the input as defined on the Building Block Definition.",
"nullable": true
}
}
}
},
"description": "Map of input keys to their input data."
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
},
"buildingBlockDefinitionVersionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockDefinitionVersion\""
},
"uuid": {
"type": "string",
"description": "The uuid of the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "The reference to the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "All fields in this section describe the Building Block."
},
"status": {
"required": [
"forcePurge",
"lifecycle",
"outputs",
"status"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the date when a user requested the deletion is provided via this field. e.g. `2020-12-22T09:37:43Z`",
"nullable": true
},
"deletedOn": {
"type": "string",
"description": "If the Building Block has been deleted, the date when it was deleted.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block. ACTIVE, MARKED_FOR_DELETION or DELETED."
},
"createdOn": {
"type": "string",
"description": "The date when the Building Block was created (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
}
},
"description": "Lifecycle information of the Building Block."
},
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value of this output.",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the output as defined on the Building Block Definition. One of NONE, PLATFORM_TENANT_ID, SIGN_IN_URL, RESOURCE_URL, SUMMARY.",
"nullable": true
}
}
}
},
"description": "Map of output keys to their output data."
},
"forcePurge": {
"type": "boolean",
"description": "Indicates whether this building block was marked to be purged."
},
"latestRunUuid": {
"type": "string",
"description": "The UUID of the latest meshBuildingBlockRun for this Building Block. This field is null when the caller's permissions are not sufficient to view runs \u2014 for example, when the API key has workspace-scoped access only and the Building Block Definition does not have run transparency enabled.",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
},
"description": "All fields in this section describe the current status of the Building Block."
}
}
},
"meshLandingZone-Put-aws": {
"title": "meshLandingZone-Put-aws",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"tags"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier as 'name' to uniquely identify the meshLandingZone."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshLandingZone."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshLandingZone."
}
},
"description": "Always contains the 'name' to uniquely identify the meshLandingZone."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLandingZone datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLandingZone' for this endpoint."
},
"spec": {
"required": [
"automateDeletionApproval",
"automateDeletionReplication",
"displayName",
"mandatoryBuildingBlockRefs",
"platformRef",
"quotas",
"recommendedBuildingBlockRefs"
],
"type": "object",
"properties": {
"platformProperties": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more Kubernetes ClusterRoles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the Kubernetes Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of Kubernetes ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to Kubernetes ClusterRoles."
}
}
}
}
}
},
"gcp": {
"required": [
"gcpFolderId",
"gcpRoleMappings"
],
"type": "object",
"properties": {
"gcpFolderId": {
"type": "string",
"description": "Google Cloud Projects will be added to this Google Cloud Folder. This allows applying Organization Policies to all projects managed under this Landing Zone."
},
"gcpRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more GCP roles. You can use both built-in roles like 'roles/editor' or custom roles like 'organizations/123123123123/roles/meshstack.project_developer'. For more information see https://docs.meshcloud.io/meshstack.gcp.landing-zones/#meshrole-to-platform-role-mapping[the Landing Zone documentation]. Multiple GCP Roles can be assigned to one meshRole. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of GCP role identifiers assigned to users with the referenced meshProject role. Supports built-in roles (e.g. 'roles/editor') and custom roles (e.g. 'organizations/123/roles/my.role').",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to GCP roles."
}
}
}
},
"gcpTemplateUrl": {
"type": "string",
"description": "URL to a GCP bucket (starts with 'gs://') with a template config. The template is deployed in the project during the replication process. Only YAML files are supported with a file size limit of 1 MB.",
"nullable": true
},
"gcpCloudFunctionUrl": {
"type": "string",
"description": "If a GCP Cloud Function URL is provided it is getting called at the end of the replication process.",
"nullable": true
}
}
},
"azurerg": {
"required": [
"azureRgLocation",
"azureRgRoleMappings"
],
"type": "object",
"properties": {
"azureRgRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure Resource Group specific access role. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitionIds",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitionIds": {
"type": "array",
"description": "A list of Azure Role Definition IDs (e.g. 'fd876abe-603d-44d2-bf8a-067bbeacd485') that will be attached to users assigned to this role mapping within the Resource Group.",
"items": {
"type": "string"
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure Resource Group role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureRgLocation": {
"type": "string",
"description": "The newly created Resource Group for the meshProjects will get assigned to this location. It must be all lower case and without spaces (e.g. eastus2 for East US 2). In order to list the available locations you can use `az account list-locations --query \"[*].name\" --out tsv | sort`"
}
}
},
"openshift": {
"type": "object",
"description": "OpenShift platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"custom": {
"type": "object",
"description": "Custom platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"aks": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more AKS Cluster Roles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the AKS Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of AKS ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to AKS Cluster Roles."
}
}
}
}
}
},
"type": {
"type": "string",
"description": "The platform type. Possible values are: 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift'."
},
"aws": {
"required": [
"awsEnrollAccount",
"awsRoleMappings",
"awsTargetOrgUnitId"
],
"type": "object",
"properties": {
"awsTargetOrgUnitId": {
"type": "string",
"description": "The created AWS account for this Landing Zone will be put under the given Organizational Unit. You can also input a Root ID (starting with 'r-') then the account will be put directly under this root without assigning it to an OU (this is not recommended)."
},
"awsLambdaArn": {
"type": "string",
"description": "If this Lambda ARN is given, it is invoked after each project replication. You can use it to trigger a custom Account Vending Machine to perform several additional provisioning steps.",
"nullable": true
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS Role. The AWS role will be part of the role or group name within AWS. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRole",
"policies",
"projectRoleRef"
],
"type": "object",
"properties": {
"policies": {
"type": "array",
"description": "A list of AWS policy ARNs (e.g. 'arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess') that will be attached to the AWS IAM role. Leave empty if you use external roles that are managed outside meshStack.",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an AWS role."
},
"platformRole": {
"type": "string",
"description": "The AWS IAM role name that users with the referenced meshProject role will be assigned to. This role must exist in the AWS account."
}
}
}
},
"awsEnrollAccount": {
"type": "boolean",
"description": "If true, accounts will be enrolled to AWS control tower. In case an enrollment configuration is provided for the AWS platform AND this value is set to true, created AWS accounts will automatically be enrolled with AWS Control Tower. Automatic account enrollment does also require the Target Organizational Unit to already be enrolled with AWS Control Tower and the corresponding meshfed-service role needs to be in the \"IAM Principal\" list for the Portfolio access of the Account Factory Product ID you defined in platform settings. Click https://docs.meshcloud.io/integrations/aws/how-to-integrate/#8-integrate-aws-control-tower[here] to learn more about the Control Tower setup."
}
}
},
"azure": {
"required": [
"azureManagementGroupId",
"azureRoleMappings"
],
"type": "object",
"properties": {
"azureRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure specific access role. If empty, default role mappings defined on meshPlatform level are used. For more information see https://docs.meshcloud.io/meshstack.azure.landing-zones#meshrole-to-platform-role-mapping[the Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitions",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitions": {
"type": "array",
"description": "A list of Azure Role Definitions with the given IDs that will be attached to this Azure role mapping.",
"items": {
"required": [
"azureRoleDefinitionId"
],
"type": "object",
"properties": {
"abacCondition": {
"type": "string",
"description": "An optional ABAC (Attribute-Based Access Control) condition expression for the role assignment. When set, this condition restricts the scope of the role assignment.",
"nullable": true
},
"azureRoleDefinitionId": {
"type": "string",
"description": "The ID of the Azure Role Definition to attach (e.g. 'c5935d7e-37b2-4f34-af8f-bdca2408296e'). You can use `az role definition list` to find available role definition IDs."
}
}
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureManagementGroupId": {
"type": "string",
"description": "Subscriptions with this Landing Zone will be added to this Management Group. Please make sure to use the Management Group ID and not the group name!"
}
}
}
},
"description": "Custom properties for the platform of the landing zone. The values depend on the platform type. "
},
"quotas": {
"type": "array",
"description": "List of default quotas applied via this landing zone. Quotas define resource limits that will be applied to tenants using this landing zone. Tenants can afterwards request different quotas if needed. The available quota keys depend on the platform type and its quota definitions. For platforms that do not support quotas, this will be an empty array.",
"items": {
"required": [
"key",
"value"
],
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The quota value for this landing zone. Must be within the min/max range defined in the platform's quota definition."
},
"key": {
"type": "string",
"description": "The quota key as defined in the platform's quota definitions. Must match a quota definition key from the platform."
}
}
}
},
"automateDeletionApproval": {
"type": "boolean",
"description": "Whether deletion approval is automated for this landing zone."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshLandingZone."
},
"description": {
"type": "string",
"description": "The description of the meshLandingZone.",
"nullable": true
},
"automateDeletionReplication": {
"type": "boolean",
"description": "Whether deletion replication is automated for this landing zone."
},
"mandatoryBuildingBlockRefs": {
"type": "array",
"description": "List of mandatory building blocks that must be present when creating tenants with this landing zone. Building blocks are additional infrastructure components or configurations that enhance tenant capabilities. All mandatory building blocks will be automatically added to tenants created with this landing zone. Validation rule: If a mandatory building block has parent dependencies, all parent building blocks must also be included in the mandatory list.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition . Must refer to an existing building block definition. If a mandatory building block depends on other building blocks (parent dependencies), those parent building blocks must also be included in the mandatory list."
}
}
}
},
"recommendedBuildingBlockRefs": {
"type": "array",
"description": "List of recommended building blocks that are suggested when creating tenants with this landing zone. These building blocks are not mandatory and can be optionally selected by users during tenant creation. Validation rule: If a recommended building block has parent dependencies, all parent building blocks must be included in either the mandatory or recommended lists.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition. Must refer to an existing building block definition. If a recommended building block depends on other building blocks (parent dependencies), those parent building blocks must be included in either the mandatory or recommended lists."
}
}
}
},
"platformRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshPlatform\""
},
"uuid": {
"type": "string",
"description": "The UUID of the platform instance."
}
},
"description": "Reference to the platform instance this landing zone belongs to."
},
"infoLink": {
"type": "string",
"description": "An optional link to describe more details about the landing zone",
"nullable": true
}
},
"description": "All fields in this section describe the meshLandingZone."
},
"status": {
"required": [
"lifecycle",
"restricted"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the landing zone. Possible values: ACTIVE (landing zone is active and can be used), DEACTIVATED (landing zone has been deactivated and cannot be used anymore)."
}
},
"description": "Lifecycle information of the landing zone."
},
"restricted": {
"type": "boolean",
"description": "If true, users will be unable to select this landing zone in meshPanel. Only Platform teams can create tenants using restricted landing zones with the meshObject API."
}
},
"description": "Current status of the meshLandingZone."
}
}
},
"meshEventLogList": {
"title": "meshEventLogList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshEventLogs"
],
"type": "object",
"properties": {
"meshEventLogs": {
"type": "array",
"description": "List of meshEventLogs.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"createdAt",
"uuid"
],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "The timestamp when this event log was created (ISO-8601 format)."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies this event log."
}
},
"description": "Contains metadata about the event log, including its UUID and creation timestamp."
},
"apiVersion": {
"type": "string",
"description": "Version of meshEventLog datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshEventLog."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshEventLog' for this endpoint."
},
"spec": {
"required": [
"author",
"content",
"description",
"eventType",
"title"
],
"type": "object",
"properties": {
"author": {
"required": [
"authorType",
"identifier"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the author who triggered this event. Depending on the `authorType`, this is:\n* ApiKey: The Key ID (UUID) of the ApiKey\n* ApiUser: The username of the ApiUser\n* System: Always `system` (only a single System author exists)\n* Unknown: Usually the username of a user that has been deleted\n* User: The `uuid` of the User"
},
"authorType": {
"type": "string",
"description": "The type of author who triggered this event. Possible values: ApiKey, ApiUser, System, Unknown, User."
}
},
"description": "Information about the author who triggered this event."
},
"description": {
"type": "string",
"description": "A detailed description of the event."
},
"previousContent": {
"type": "object",
"description": "The previous content/state before this event occurred, represented as a JSON object. Only present for events of type `Changed`.",
"nullable": true
},
"workspaceRef": {
"type": "object",
"description": "Reference to the workspace this event log is associated with. May be null for system-wide events.",
"nullable": true
},
"eventType": {
"type": "string",
"description": "The type of event. Possible values: Added, Approved, Cancelled, Changed, Created, Deleted, Rejected, Removed, Requested."
},
"title": {
"type": "string",
"description": "A brief title describing the event."
},
"content": {
"type": "object",
"description": "The current content/state associated with this event, represented as a JSON object. The structure varies depending on the event type."
}
},
"description": "All fields in this section describe the event log."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshpaymentmethods1366945563": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The paymentMethodIdentifier as 'name'."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspaceIdentifier as 'ownedByWorkspace'."
}
},
"description": "Always contains the 'name' and (optional) 'ownedByWorkspace' to uniquely identify the meshPaymentMethod."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPaymentMethod datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPaymentMethod' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The amount of the meshPaymentMethod.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshPaymentMethod as it is shown in meshPanel."
},
"expirationDate": {
"type": "string",
"description": "The expiration date (yyyy-MM-dd) of the meshPaymentMethod. The date is considered as UTC.",
"nullable": true
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshPaymentMethod. Keep in mind, that values are an array.",
"nullable": true
}
},
"description": "All fields in this section describe the meshPaymentMethod."
}
}
},
"meshUserV2": {
"title": "meshUserV2",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username as 'name' to uniquely identify the meshUser."
},
"uuid": {
"type": "string",
"description": "A unique identifier (UUID) for the meshUser.",
"nullable": true
}
},
"description": "Always contains the 'name' to uniquely identify the meshUser."
},
"apiVersion": {
"type": "string",
"description": "Version of meshUser datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshUser."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshUser' for this endpoint."
},
"spec": {
"required": [
"email",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"lastName": {
"type": "string",
"description": "The last name of the meshUser."
},
"firstName": {
"type": "string",
"description": "The first name of the meshUser."
},
"euid": {
"type": "string",
"description": "External User ID which is used to lookup the user in the cloud platforms.",
"nullable": true
},
"email": {
"type": "string",
"description": "The email of the meshUser."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshUser. Keep in mind, that values are an array.",
"nullable": true
}
},
"description": "All fields in this section describe the meshUser."
}
}
},
"meshBuildingBlockPost": {
"title": "meshBuildingBlockPost",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"createdOn",
"definitionUuid",
"definitionVersion",
"forcePurge",
"tenantIdentifier",
"uuid"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the date when a user requested the deletion is provided via this field. e.g. `2020-12-22T09:37:43Z`",
"nullable": true
},
"forcePurge": {
"type": "boolean",
"description": "Set to true, if an operator explicitly requested this Building Block to be purged."
},
"definitionVersion": {
"type": "number",
"description": "The version number of the Building Block Definition this Building Block is based on."
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block has already been deleted, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The Building Block has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
},
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition this Building Block is based on."
},
"tenantIdentifier": {
"type": "string",
"description": "The full identifier of the tenant, this Building Block is created in."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block. It also contains additional meta information like the Building Block creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"displayName",
"inputs",
"parentBuildingBlocks"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of inputs, which are set on the Building Block.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"inputs": {
"type": "array",
"description": "List of inputs, which are set on the Building Block.",
"items": {
"required": [
"key",
"value",
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value, which is set on this input."
},
"key": {
"type": "string",
"description": "The key of the input as set on the related Building Block Definition."
}
}
}
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
}
},
"description": "All fields in this section describe the Building Block."
},
"status": {
"required": [
"outputs",
"status"
],
"type": "object",
"properties": {
"outputs": {
"type": "array",
"description": "List of outputs, which are set on the Building Block. Empty, just after creation.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"status": {
"type": "string",
"description": "The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
},
"description": "All fields in this section describe the current status of the Building Block."
}
}
},
"meshCommunication": {
"title": "meshCommunication",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the communication."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns the communication"
}
},
"description": "Always contains the 'uuid' to uniquely identify the communication. It also contains additional meta information."
},
"apiVersion": {
"type": "string",
"description": "Version of meshCommunication datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshCommunication' for this endpoint."
},
"spec": {
"required": [
"communicationDefinitionRef",
"targetMeshObjectRef"
],
"type": "object",
"properties": {
"communicationDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshCommunicationDefinition\""
},
"uuid": {
"type": "string",
"description": "UUID of the associated communication definition."
}
},
"description": "Reference to the associated communication definition."
},
"targetMeshObjectRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "What kind of meshObject is targeted (e.g. meshWorkspace)"
},
"name": {
"type": "string",
"description": "An name or identifier to uniquely identify the targeted meshObject"
}
},
"description": "Describes the meshObject that is targeted by this communication"
}
},
"description": "All fields in this section describe the communication."
},
"status": {
"required": [
"meshCommunicationDefinition",
"resolutionStatus"
],
"type": "object",
"properties": {
"meshCommunicationDefinition": {
"required": [
"communicationType",
"dueDate",
"title",
"uuid"
],
"type": "object",
"properties": {
"dueDate": {
"type": "string",
"description": "The due date of the meshCommunicationDefinition in ISO 8601 format (YYYY-MM-DD). Only present if a due date was specified for the communication definition."
},
"communicationType": {
"type": "string",
"description": "Either NOTIFICATION or ACTION_REQUIRED."
},
"title": {
"type": "string",
"description": "The title of the meshCommunicationDefinition."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshCommunicationDefinition."
}
},
"description": "the communication definition associated to this communication."
},
"resolutionStatus": {
"type": "string",
"description": "only present if the associated communication definition is of type ACTION_REQUIRED. Either OPEN or RESOLVED."
}
},
"description": "contains the current status as well as the associated meshCommunicationDefinition"
}
}
},
"meshWorkspaceUserGroup": {
"title": "meshWorkspaceUserGroup",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The workspaceUserGroupIdentifier as 'name' to uniquely identify the meshWorkspaceUserGroup."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this WorkspaceUserGroup."
}
},
"description": "Always contains the 'name' to uniquely identify the meshWorkspaceUserGroup. It also contains the workspace name that owns this WorkspaceUserGroup."
},
"apiVersion": {
"type": "string",
"description": "Version of meshWorkspaceUserGroup datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshWorkspaceUserGroup."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshWorkspaceUserGroup' for this endpoint."
},
"spec": {
"required": [
"displayName",
"members",
"tags"
],
"type": "object",
"properties": {
"egid": {
"type": "string",
"description": "External Group Identifier, this is an optional field.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshWorkspaceUserGroup as it is shown in meshPanel."
},
"members": {
"type": "array",
"description": "List of usernames",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshWorkspaceUserGroup. Keep in mind, that values are an array."
}
},
"description": "All fields in this section describe the meshWorkspaceUserGroup."
}
}
},
"meshPlatformTypeListV1": {
"title": "meshPlatformTypeListV1",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshPlatformTypes"
],
"type": "object",
"properties": {
"meshPlatformTypes": {
"type": "array",
"description": "List of meshPlatformTypes.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshPlatformType."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshPlatformType across all platform types.",
"nullable": true
}
},
"description": "Contains the identifiers for the meshPlatformType."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatformType datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshPlatformType."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this endpoint."
},
"spec": {
"required": [
"category",
"displayName",
"icon"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshPlatformType shown in the UI."
},
"icon": {
"type": "string",
"description": "The icon used to display the platform type in the UI. This must be provided as a base64 encoded data image. Size should be kept small to ensure fast loading times and efficient storage."
},
"defaultEndpoint": {
"type": "string",
"description": "The default endpoint URL for the platform type. This will be used as a default value when creating platform instances. The default endpoint should be a link to a web portal of the cloud platform for example.",
"nullable": true
},
"category": {
"type": "string",
"description": "The platform category. For custom platform types, this is always 'CUSTOM'. Possible values: OPENSTACK, CLOUDFOUNDRY, SERVICEREGISTRY, AWS, OPENSHIFT, KUBERNETES, AZURE, GCP, AZURE_KUBERNETES_SERVICE, AZURE_RESOURCE_GROUP, CUSTOM, GITHUB."
}
},
"description": "All fields in this section describe the meshPlatformType configuration."
},
"status": {
"required": [
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The lifecycle state of the platform type. Can be 'ACTIVE' or 'DEACTIVATED'. Deactivated platform types cannot be used to create new platform instances."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the meshPlatformType was created.",
"nullable": true
}
},
"description": "The lifecycle information of the platform type."
}
},
"description": "The current status of the meshPlatformType."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshProjectUserBindingCreateV3": {
"title": "meshProjectUserBindingCreateV3",
"required": [
"_links",
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the project the user was assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the project the user was assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of this binding which later can be used to refer to it"
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of this object"
},
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"kind": {
"type": "string",
"description": "Type of the returned meshObject"
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username of the referenced user."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this user."
}
}
}
}
},
"meshObjectsRootV1": {
"title": "meshObjectsRootV1",
"required": [
"_links"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "All available meshObject Links for the authenticated user."
}
}
},
"meshLandingZone-List": {
"title": "meshLandingZone-List",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Contains the self link and pagination links (first, last, next, prev)."
},
"_embedded": {
"required": [
"meshLandingZones"
],
"type": "object",
"properties": {
"meshLandingZones": {
"type": "array",
"description": "List of meshLandingZones.",
"items": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"tags"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier as 'name' to uniquely identify the meshLandingZone."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshLandingZone."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshLandingZone."
}
},
"description": "Always contains the 'name' to uniquely identify the meshLandingZone."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLandingZone datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLandingZone' for this endpoint."
},
"spec": {
"required": [
"automateDeletionApproval",
"automateDeletionReplication",
"displayName",
"mandatoryBuildingBlockRefs",
"platformRef",
"quotas",
"recommendedBuildingBlockRefs"
],
"type": "object",
"properties": {
"platformProperties": {
"type": "object",
"properties": {
"kubernetes": {
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more Kubernetes ClusterRoles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the Kubernetes Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of Kubernetes ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"projectRoleRef": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref.",
"nullable": true
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader').",
"nullable": true
}
},
"description": "Reference to the meshProject role that is being mapped to Kubernetes ClusterRoles."
}
}
}
}
}
},
"gcp": {
"type": "object",
"properties": {
"gcpFolderId": {
"type": "string",
"description": "Google Cloud Projects will be added to this Google Cloud Folder. This allows applying Organization Policies to all projects managed under this Landing Zone.",
"nullable": true
},
"gcpRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more GCP roles. You can use both built-in roles like 'roles/editor' or custom roles like 'organizations/123123123123/roles/meshstack.project_developer'. For more information see https://docs.meshcloud.io/meshstack.gcp.landing-zones/#meshrole-to-platform-role-mapping[the Landing Zone documentation]. Multiple GCP Roles can be assigned to one meshRole. If empty, the default that is configured on platform level will be used.",
"items": {
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of GCP role identifiers assigned to users with the referenced meshProject role. Supports built-in roles (e.g. 'roles/editor') and custom roles (e.g. 'organizations/123/roles/my.role').",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"projectRoleRef": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref.",
"nullable": true
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader').",
"nullable": true
}
},
"description": "Reference to the meshProject role that is being mapped to GCP roles."
}
}
}
},
"gcpTemplateUrl": {
"type": "string",
"description": "URL to a GCP bucket (starts with 'gs://') with a template config. The template is deployed in the project during the replication process. Only YAML files are supported with a file size limit of 1 MB.",
"nullable": true
},
"gcpCloudFunctionUrl": {
"type": "string",
"description": "If a GCP Cloud Function URL is provided it is getting called at the end of the replication process.",
"nullable": true
}
}
},
"azurerg": {
"type": "object",
"properties": {
"azureRgRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure Resource Group specific access role. If empty, the default that is configured on platform level will be used.",
"items": {
"type": "object",
"properties": {
"azureRoleDefinitionIds": {
"type": "array",
"description": "A list of Azure Role Definition IDs (e.g. 'fd876abe-603d-44d2-bf8a-067bbeacd485') that will be attached to users assigned to this role mapping within the Resource Group.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance.",
"nullable": true
},
"projectRoleRef": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref.",
"nullable": true
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader').",
"nullable": true
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure Resource Group role."
}
}
}
},
"azureFunction": {
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`",
"nullable": true
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureRgLocation": {
"type": "string",
"description": "The newly created Resource Group for the meshProjects will get assigned to this location. It must be all lower case and without spaces (e.g. eastus2 for East US 2). In order to list the available locations you can use `az account list-locations --query \"[*].name\" --out tsv | sort`",
"nullable": true
}
}
},
"openshift": {
"type": "object",
"description": "OpenShift platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"custom": {
"type": "object",
"description": "Custom platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"aks": {
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more AKS Cluster Roles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the AKS Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of AKS ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"projectRoleRef": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref.",
"nullable": true
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader').",
"nullable": true
}
},
"description": "Reference to the meshProject role that is being mapped to AKS Cluster Roles."
}
}
}
}
}
},
"type": {
"type": "string",
"description": "The platform type. Possible values are: 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift'.",
"nullable": true
},
"aws": {
"type": "object",
"properties": {
"awsTargetOrgUnitId": {
"type": "string",
"description": "The created AWS account for this Landing Zone will be put under the given Organizational Unit. You can also input a Root ID (starting with 'r-') then the account will be put directly under this root without assigning it to an OU (this is not recommended).",
"nullable": true
},
"awsLambdaArn": {
"type": "string",
"description": "If this Lambda ARN is given, it is invoked after each project replication. You can use it to trigger a custom Account Vending Machine to perform several additional provisioning steps.",
"nullable": true
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS Role. The AWS role will be part of the role or group name within AWS. If empty, the default that is configured on platform level will be used.",
"items": {
"type": "object",
"properties": {
"policies": {
"type": "array",
"description": "A list of AWS policy ARNs (e.g. 'arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess') that will be attached to the AWS IAM role. Leave empty if you use external roles that are managed outside meshStack.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"projectRoleRef": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref.",
"nullable": true
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader').",
"nullable": true
}
},
"description": "Reference to the meshProject role that is being mapped to an AWS role."
},
"platformRole": {
"type": "string",
"description": "The AWS IAM role name that users with the referenced meshProject role will be assigned to. This role must exist in the AWS account.",
"nullable": true
}
}
}
},
"awsEnrollAccount": {
"type": "boolean",
"description": "If true, accounts will be enrolled to AWS control tower. In case an enrollment configuration is provided for the AWS platform AND this value is set to true, created AWS accounts will automatically be enrolled with AWS Control Tower. Automatic account enrollment does also require the Target Organizational Unit to already be enrolled with AWS Control Tower and the corresponding meshfed-service role needs to be in the \"IAM Principal\" list for the Portfolio access of the Account Factory Product ID you defined in platform settings. Click https://docs.meshcloud.io/integrations/aws/how-to-integrate/#8-integrate-aws-control-tower[here] to learn more about the Control Tower setup.",
"nullable": true
}
}
},
"azure": {
"type": "object",
"properties": {
"azureRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure specific access role. If empty, default role mappings defined on meshPlatform level are used. For more information see https://docs.meshcloud.io/meshstack.azure.landing-zones#meshrole-to-platform-role-mapping[the Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"type": "object",
"properties": {
"azureRoleDefinitions": {
"type": "array",
"description": "A list of Azure Role Definitions with the given IDs that will be attached to this Azure role mapping.",
"items": {
"type": "object",
"properties": {
"abacCondition": {
"type": "string",
"description": "An optional ABAC (Attribute-Based Access Control) condition expression for the role assignment. When set, this condition restricts the scope of the role assignment.",
"nullable": true
},
"azureRoleDefinitionId": {
"type": "string",
"description": "The ID of the Azure Role Definition to attach (e.g. 'c5935d7e-37b2-4f34-af8f-bdca2408296e'). You can use `az role definition list` to find available role definition IDs.",
"nullable": true
}
}
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance.",
"nullable": true
},
"projectRoleRef": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref.",
"nullable": true
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader').",
"nullable": true
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure role."
}
}
}
},
"azureFunction": {
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`",
"nullable": true
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureManagementGroupId": {
"type": "string",
"description": "Subscriptions with this Landing Zone will be added to this Management Group. Please make sure to use the Management Group ID and not the group name!",
"nullable": true
}
}
}
},
"description": "Custom properties for the platform of the landing zone. The values depend on the platform type. "
},
"quotas": {
"type": "array",
"description": "List of default quotas applied via this landing zone. Quotas define resource limits that will be applied to tenants using this landing zone. Tenants can afterwards request different quotas if needed. The available quota keys depend on the platform type and its quota definitions. For platforms that do not support quotas, this will be an empty array.",
"items": {
"required": [
"key",
"value"
],
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The quota value for this landing zone. Must be within the min/max range defined in the platform's quota definition."
},
"key": {
"type": "string",
"description": "The quota key as defined in the platform's quota definitions. Must match a quota definition key from the platform."
}
}
}
},
"automateDeletionApproval": {
"type": "boolean",
"description": "Whether deletion approval is automated for this landing zone."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshLandingZone."
},
"description": {
"type": "string",
"description": "The description of the meshLandingZone.",
"nullable": true
},
"automateDeletionReplication": {
"type": "boolean",
"description": "Whether deletion replication is automated for this landing zone."
},
"mandatoryBuildingBlockRefs": {
"type": "array",
"description": "List of mandatory building blocks that must be present when creating tenants with this landing zone. Building blocks are additional infrastructure components or configurations that enhance tenant capabilities. All mandatory building blocks will be automatically added to tenants created with this landing zone. Validation rule: If a mandatory building block has parent dependencies, all parent building blocks must also be included in the mandatory list.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition . Must refer to an existing building block definition. If a mandatory building block depends on other building blocks (parent dependencies), those parent building blocks must also be included in the mandatory list."
}
}
}
},
"recommendedBuildingBlockRefs": {
"type": "array",
"description": "List of recommended building blocks that are suggested when creating tenants with this landing zone. These building blocks are not mandatory and can be optionally selected by users during tenant creation. Validation rule: If a recommended building block has parent dependencies, all parent building blocks must be included in either the mandatory or recommended lists.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition. Must refer to an existing building block definition. If a recommended building block depends on other building blocks (parent dependencies), those parent building blocks must be included in either the mandatory or recommended lists."
}
}
}
},
"platformRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshPlatform\""
},
"uuid": {
"type": "string",
"description": "The UUID of the platform instance."
}
},
"description": "Reference to the platform instance this landing zone belongs to."
},
"infoLink": {
"type": "string",
"description": "An optional link to describe more details about the landing zone",
"nullable": true
}
},
"description": "All fields in this section describe the meshLandingZone."
},
"status": {
"required": [
"lifecycle",
"restricted"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the landing zone. Possible values: ACTIVE (landing zone is active and can be used), DEACTIVATED (landing zone has been deactivated and cannot be used anymore)."
}
},
"description": "Lifecycle information of the landing zone."
},
"restricted": {
"type": "boolean",
"description": "If true, users will be unable to select this landing zone in meshPanel. Only Platform teams can create tenants using restricted landing zones with the meshObject API."
}
},
"description": "Current status of the meshLandingZone."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshBuildingBlockDefinitionV1": {
"title": "meshBuildingBlockDefinitionV1",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition.",
"nullable": true
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the Building Block Definition. Keep in mind, that values are an array.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition. It also contains additional meta information like the Building Block Definition creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this endpoint."
},
"spec": {
"required": [
"description",
"displayName",
"targetType",
"useInLandingZonesOnly"
],
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the Building Block Definition as it is shown in meshPanel.",
"nullable": true
},
"documentationUrl": {
"type": "string",
"description": "The URL pointing to documentation of the Building Block Definition. (optional)",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block Definition as it is shown in meshPanel."
},
"supportUrl": {
"type": "string",
"description": "The URL pointing to support of the Building Block Definition. (optional)",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the Building Block Definition as it is shown in meshPanel."
},
"targetType": {
"type": "string",
"description": "The type of Building Block Definition. (One of ['TENANT_LEVEL', 'WORKSPACE_LEVEL'.])"
},
"runTransparency": {
"type": "boolean",
"description": "Specifies the Building Block Definition run control. When set to true, both platform teams and workspace users can view detailed run logs and re-run building blocks. When set to false (default), only platform teams have this access.",
"nullable": true
},
"supportedPlatforms": {
"type": "array",
"description": "Set of the platform types this Building Block Definition supports. Must be non-empty if targetType is 'TENANT_LEVEL', otherwise null. Each entry is a meshPlatformType reference.",
"items": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object. Must be 'meshPlatformType'."
},
"name": {
"type": "string",
"description": "The unique identifier of the platform type (corresponds to the `metadata.name` of a meshPlatformType)."
}
}
}
},
"notificationSubscriberUsernames": {
"type": "array",
"description": "A set of usernames or emails that should be notified as subscribers for this Building Block Definition. Prefix entries with `user:` or `email:`.",
"nullable": true,
"items": {
"type": "string"
}
},
"useInLandingZonesOnly": {
"type": "boolean",
"description": "Indicates whether this Building Block Definition should be used on Landing Zones only."
}
},
"description": "All fields in this section describe the Building Block Definition."
},
"status": {
"required": [
"latestVersion",
"latestVersionUuid",
"lifecycle",
"versions"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the date when a user requested the deletion is provided via this field (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block Definition. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information about the Building Block Definition."
},
"latestReleasedVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"versions": {
"type": "array",
"description": "List of meshBuildingBlockDefinitionVersions, which exist for the Building Block Definition.",
"items": {
"required": [
"state",
"versionNumber",
"versionUuid"
],
"type": "object",
"properties": {
"versionUuid": {
"type": "string",
"description": "The uuid of the listed version."
},
"state": {
"type": "string",
"description": "The state of the listed version. (One of ['DRAFT', 'RELEASED'])"
},
"versionNumber": {
"type": "number",
"description": "The number of the listed version."
}
}
}
},
"latestReleasedVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"latestVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition including a possible draft version."
},
"usageCount": {
"type": "number",
"description": "The number of Building Blocks using this Building Block Definition.",
"nullable": true
},
"latestVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition including a possible draft version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition."
}
}
},
"apiKeyLoginResponse": {
"title": "apiKeyLoginResponse",
"required": [
"access_token",
"expires_in",
"not-before-policy",
"refresh_expires_in",
"scope",
"token_type"
],
"type": "object",
"properties": {
"access_token": {
"type": "string",
"description": "The access token issued by the authorization server. This token must be included in the Authorization header as a Bearer token when making authenticated API requests."
},
"refresh_expires_in": {
"type": "number",
"description": "The number of seconds until the refresh token expires. After this time, a new login is required."
},
"scope": {
"type": "string",
"description": "The scopes granted to the access token, indicating the permissions associated with the token."
},
"not-before-policy": {
"type": "number",
"description": "The timestamp (in seconds since epoch) before which the token is not valid."
},
"token_type": {
"type": "string",
"description": "The type of the token issued. Typically 'Bearer'."
},
"expires_in": {
"type": "number",
"description": "The number of seconds until the access token expires and must be refreshed."
}
}
},
"api-meshobjects-meshprojectbindings-groupbindings1480218446": {
"required": [
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the project the group should get assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of this binding which later can be used to refer to it. It must be globally unique."
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of this object"
},
"kind": {
"type": "string",
"description": "Type of the returned meshObject"
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the referenced group."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this group."
}
}
}
}
},
"meshLocation-Put": {
"title": "meshLocation-Put",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshLocation."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshLocation. This is a common attribute for all meshObjects, but in case of a meshLocation it is not used for referencing the location. Instead the name (identifier) is used.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this location."
}
},
"description": "Contains the identifiers for the meshLocation."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLocation datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshLocation."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLocation' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshLocation shown in the UI."
},
"description": {
"type": "string",
"description": "An optional description of the meshLocation.",
"nullable": true
}
},
"description": "All fields in this section describe the meshLocation configuration."
},
"status": {
"required": [
"isPublic"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the meshLocation was deleted. Null if the location has not been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the meshLocation. Possible values are: ACTIVE, DEACTIVATED, DELETED."
},
"createdOn": {
"type": "string",
"description": "The timestamp when the meshLocation was created."
}
},
"description": "The lifecycle status of the meshLocation."
},
"isPublic": {
"type": "boolean",
"description": "Indicates whether the location has any public platform instances associated with it."
}
},
"description": "The current status of the meshLocation."
}
}
},
"meshTagDefinition": {
"title": "meshTagDefinition",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Must be of the form `$targetKind.$key` since tag definitions must be non-conflicting."
}
},
"description": "Always contains the 'name' to uniquely identify the meshTagDefinition."
},
"apiVersion": {
"type": "string",
"description": "Version of `meshTagDefinition` datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the `self` link."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a `kind`. This is always `meshTagDefinition` for this endpoint."
},
"spec": {
"required": [
"description",
"displayName",
"key",
"targetKind",
"valueType"
],
"type": "object",
"properties": {
"immutable": {
"type": "boolean",
"description": "Indicates whether the tag value is not editable after initially set.",
"nullable": true
},
"replicationKey": {
"type": "string",
"description": "The key for this tag when replicated to cloud platforms. If null, replication is disabled.",
"nullable": true
},
"restricted": {
"type": "boolean",
"description": "Indicates whether only admins can edit this tag.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the tag."
},
"valueType": {
"type": "object",
"properties": {
"number": {
"type": "object",
"properties": {
"defaultValue": {
"type": "number",
"description": "The default value of the tag.",
"nullable": true
}
},
"description": "a decimal number, represented a JSON number"
},
"string": {
"type": "object",
"properties": {
"defaultValue": {
"type": "string",
"description": "The default value of the tag.",
"nullable": true
},
"validationRegex": {
"type": "string",
"description": "The regex pattern that the tag value must match.",
"nullable": true
}
},
"description": "string, represented as JSON string"
},
"integer": {
"type": "object",
"properties": {
"defaultValue": {
"type": "number",
"description": "The default value of the tag.",
"nullable": true
}
},
"description": "an integer, represented as a JSON number"
},
"singleSelect": {
"required": [
"options"
],
"type": "object",
"properties": {
"defaultValue": {
"type": "string",
"description": "The default value of the tag.",
"nullable": true
},
"options": {
"type": "array",
"description": "The allowed options for the tag as a string[]",
"items": {
"type": "string"
}
}
},
"description": "a string from a list of options, represented as a JSON string"
},
"email": {
"type": "object",
"properties": {
"defaultValue": {
"type": "string",
"description": "The default value of the tag.",
"nullable": true
},
"validationRegex": {
"type": "string",
"description": "The regex pattern that the tag value must match.",
"nullable": true
}
},
"description": "email address, represented as JSON string"
},
"multiSelect": {
"required": [
"options"
],
"type": "object",
"properties": {
"defaultValue": {
"type": "array",
"description": "The default value of the tag.",
"nullable": true,
"items": {
"type": "string"
}
},
"options": {
"type": "array",
"description": "The allowed options for the tag as a string[]",
"items": {
"type": "string"
}
}
},
"description": "one or multiple strings from a list of option, represented as a JSON array"
}
},
"description": "The TagValueType of the tag. Must define exactly one of the available types."
},
"sortOrder": {
"type": "number",
"description": "The sort order for this tag when displayed in the UI. meshPanel sorts tags in ascending order.",
"nullable": true
},
"targetKind": {
"type": "string",
"description": "The kind of meshObject this tag is defined for. At this moment only the following kinds are supported by meshStack: `meshWorkspace, meshProject, meshLandingZone, meshPaymentMethod, meshBuildingBlockDefinition, meshProjectRole, meshPrincipal`"
},
"description": {
"type": "string",
"description": "The detailed description of the tag."
},
"mandatory": {
"type": "boolean",
"description": "Indicates whether the tag is mandatory.",
"nullable": true
},
"key": {
"type": "string",
"description": "The key of the tag. This key must be unique for all tags defined for the same `targetKind`."
}
},
"description": "Specification for the meshTagDefinition."
}
}
},
"meshTenantV4": {
"title": "meshTenantV4",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The identifier of the meshProject the meshTenant belongs to."
},
"markedForDeletionOn": {
"type": "string",
"description": "If the meshTenant has been submitted for deletion by a Workspace Manager, the date is represented here (e.g. `2020-12-22T09:37:43Z)`. Otherwise this field is missing.",
"nullable": true
},
"deletedOn": {
"type": "string",
"description": "If the meshTenant was deleted successfully in the cloud platform, the date is represented here (e.g. `2020-12-22T10:12:25Z)`. Otherwise this field is missing.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The creation date of the meshTenant.",
"nullable": true
},
"uuid": {
"type": "string",
"description": "The UUID of the meshTenant. It must be used to reference a meshTenant.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the meshTenant belongs to."
}
},
"description": "Contains common meshObject data."
},
"apiVersion": {
"type": "string",
"description": "Version of meshTenant datatype. Matches the version provided in the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshTenant' for this endpoint."
},
"spec": {
"required": [
"platformIdentifier",
"quotas"
],
"type": "object",
"properties": {
"quotas": {
"type": "array",
"description": "The set of applied Tenant Quotas. They can be set individually per tenant. By default the Landing Zone quotas are applied to new meshTenants.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"platformTenantId": {
"type": "string",
"description": "The platform tenant id related to this meshTenant. It will only be set if the tenant was either imported via meshObject API with a platformTenantId or if at least one replication run was executed that resulted in the creation of a platform tenant. +\n*Note:* This does not mean the whole replication must have been successful. Some steps like role assignments on this tenant might be still in progress.",
"nullable": true
},
"landingZoneIdentifier": {
"type": "string",
"description": "The identifier of the Landing Zone of this meshTenant. This field will be set for tenants of all platforms except service registries (OSB marketplaces).",
"nullable": true
},
"platformIdentifier": {
"type": "string",
"description": "The identifier of the related platform instance."
}
},
"description": "All fields in this section describe the meshTenant."
},
"status": {
"required": [
"platformTypeIdentifier",
"tags",
"tenantName"
],
"type": "object",
"properties": {
"platformWorkspaceIdentifier": {
"type": "string",
"description": "Some platforms like Cloud Foundry create a representation of a workspace. The identifier of this workspace representation is stored here. This field is not provided or null if the platform does not support this feature.",
"nullable": true
},
"tenantName": {
"type": "string",
"description": "The full name of this tenant, a concatenation of the workspace identifier, project identifier and platform identifier."
},
"tags": {
"type": "object",
"description": "The tags assigned to this meshTenant originating from meshWorkspace, Payment Method and meshProject. Keep in mind, that values are an array."
},
"platformTypeIdentifier": {
"type": "string",
"description": "The identifier of the related platform type."
}
},
"description": "All fields in this section represent the current status of the tenant and can change over time."
}
}
},
"meshProjectRoleListV1": {
"title": "meshProjectRoleListV1",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshProjectRoles"
],
"type": "object",
"properties": {
"meshProjectRoles": {
"type": "array",
"description": "List of meshProjectRoles.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshWorkspaceGroupBindingList": {
"title": "meshWorkspaceGroupBindingList",
"required": [
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshWorkspaceGroupBindings"
],
"type": "object",
"properties": {
"meshWorkspaceGroupBindings": {
"type": "array",
"description": "List of meshWorkspaceGroupBindings.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshbuildingblocks-884287178": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"definitionUuid",
"definitionVersion",
"tenantIdentifier"
],
"type": "object",
"properties": {
"definitionVersion": {
"type": "number",
"description": "The version number of the Building Block Definition this Building Block is based on."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition this Building Block is based on."
},
"tenantIdentifier": {
"type": "string",
"description": "The full identifier of the tenant, this Building Block is created in."
}
},
"description": "Fixed fields that help identify the Building Block."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"displayName",
"inputs",
"parentBuildingBlocks"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent building blocks, which are required for the Building Block. If none given, an empty list needs to be provided.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"inputs": {
"type": "array",
"description": "List of inputs, which are set on the Building Block.",
"items": {
"required": [
"key",
"value",
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value, which is set on this input."
},
"key": {
"type": "string",
"description": "The key of the input as set on the related Building Block Definition."
}
}
}
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
}
},
"description": "All fields in this section describe the Building Block."
}
}
},
"meshBuildingBlockRunner-List": {
"title": "meshBuildingBlockRunner-List",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Contains the self link and pagination links (first, last, next, prev)."
},
"_embedded": {
"required": [
"meshBuildingBlockRunners"
],
"type": "object",
"properties": {
"meshBuildingBlockRunners": {
"type": "array",
"description": "List of meshBuildingBlockRunners.",
"items": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"lastSeen": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner last connected to meshStack (ISO 8601 format). This is updated automatically whenever the runner polls for work.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner was created (ISO 8601 format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies this meshBuildingBlockRunner. Must not be provided on creation \u2014 meshStack assigns a UUID automatically. On update (PUT), this field is mandatory and must match the UUID in the path parameter.",
"nullable": true
},
"lastKnownVersion": {
"type": "string",
"description": "The last runner version reported via the X-Meshcloud-Runner-Version request header when polling for work. Null if the runner has never sent a version header.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshBuildingBlockRunner."
}
},
"description": "Contains identifying properties of the meshBuildingBlockRunner."
},
"apiVersion": {
"type": "string",
"description": "Version of meshBuildingBlockRunner datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockRunner' for this endpoint."
},
"spec": {
"required": [
"displayName",
"implementationType",
"publicKey"
],
"type": "object",
"properties": {
"implementationType": {
"type": "string",
"description": "The type of building block implementation this runner handles. Possible values: `TERRAFORM`, `GITHUB_WORKFLOW`, `GITLAB_PIPELINE`, `AZURE_DEVOPS_PIPELINE`, `MANUAL`."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of this meshBuildingBlockRunner."
},
"restriction": {
"type": "string",
"description": "Visibility restriction of this runner. `PUBLIC` makes the runner available to all workspaces in meshStack. `PRIVATE` (default) restricts it to the owning workspace. Only administrators can create or update runners with `PUBLIC` restriction.",
"nullable": true
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the GCP federated token, e.g. `/var/run/secrets/workload-identity/gcp/token`."
},
"audience": {
"type": "string",
"description": "The audience for the GCP Workload Identity Federation token, e.g. `//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/my-provider`."
}
},
"description": "GCP-specific Workload Identity Federation configuration for this runner."
},
"subject": {
"type": "string",
"description": "The subject claim of the OIDC token issued to this runner, e.g. `system:serviceaccount:meshfed:my-runner`."
},
"aws": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the AWS federated token, e.g. `/var/run/secrets/workload-identity/aws/token`."
},
"audience": {
"type": "string",
"description": "The audience for the AWS STS AssumeRoleWithWebIdentity call, typically `sts.amazonaws.com`."
},
"thumbprint": {
"type": "string",
"description": "Optional thumbprint of the OIDC provider's root CA certificate for AWS.",
"nullable": true
}
},
"description": "AWS-specific Workload Identity Federation configuration for this runner."
},
"issuer": {
"type": "string",
"description": "The OIDC issuer URL of the identity provider that issues tokens for this runner. This is used to configure trust with the target cloud provider."
},
"azure": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the Azure federated token, e.g. `/var/run/secrets/workload-identity/azure/token`."
},
"audience": {
"type": "string",
"description": "The audience for the Azure federated identity token exchange, typically `api://AzureADTokenExchange`."
}
},
"description": "Azure-specific Workload Identity Federation configuration for this runner."
}
},
"description": "Optional Workload Identity Federation (WIF) configuration for this runner. When configured, the runner can authenticate to cloud providers using short-lived tokens instead of long-lived credentials. At least one of `gcp`, `aws`, or `azure` must be provided."
},
"publicKey": {
"type": "string",
"description": "The RSA public key (PEM-encoded) used to encrypt secrets that are sent to this runner. Accepts either a PEM-encoded public key (BEGIN PUBLIC KEY) or an X.509 certificate (BEGIN CERTIFICATE). The runner uses the corresponding private key to decrypt those secrets at runtime."
},
"isSelfHosted": {
"type": "boolean",
"description": "Indicates whether this runner is self-hosted (deployed and managed by the workspace/customer). `true` for all runners created via this API. `false` for meshcloud-managed platform runners provisioned automatically by meshStack during deployment \u2014 these cannot be created via this API. This field is read-only.",
"nullable": true
}
},
"description": "All fields in this section describe the configuration of the meshBuildingBlockRunner."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshProjectPut": {
"title": "meshProjectPut",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "If the meshProject has been submitted for deletion by a Workspace Manager, the date, the date is represented here (e.g. `2020-12-22T09:37:43Z)`. Otherwise this field is missing.",
"nullable": true
},
"name": {
"type": "string",
"description": "The projectIdentifier as 'name'."
},
"createdOn": {
"type": "string",
"description": "The meshProject has been created at this date (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspaceIdentifier as 'ownedByWorkspace'."
}
},
"description": "Always contains the 'name' and 'ownedByWorkspace' to uniquely identify the meshProject."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProject datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshProject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProject' for this endpoint."
},
"spec": {
"required": [
"displayName",
"tags"
],
"type": "object",
"properties": {
"substitutePaymentMethodIdentifier": {
"type": "string",
"description": "The substitutePaymentMethod of the meshProject",
"nullable": true
},
"paymentMethodIdentifier": {
"type": "string",
"description": "The meshPaymentMethod of the meshProject.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshProject as it is shown in meshPanel."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshProject. Keep in mind, that values are an array."
}
},
"description": "All fields in this section describe the meshProject."
}
}
},
"metadataRoot": {
"title": "metadataRoot",
"required": [
"_links"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "All available Metadata Links for the authenticated user."
}
}
},
"meshLocation-List": {
"title": "meshLocation-List",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshLocations"
],
"type": "object",
"properties": {
"meshLocations": {
"type": "array",
"description": "List of meshLocations.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshLocation."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshLocation. This is a common attribute for all meshObjects, but in case of a meshLocation it is not used for referencing the location. Instead the name (identifier) is used.",
"nullable": true
}
},
"description": "Contains the identifiers for the meshLocation."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLocation datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshLocation."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLocation' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshLocation shown in the UI."
},
"description": {
"type": "string",
"description": "An optional description of the meshLocation.",
"nullable": true
}
},
"description": "All fields in this section describe the meshLocation configuration."
},
"status": {
"required": [
"isPublic"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the meshLocation was deleted. Null if the location has not been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the meshLocation. Possible values are: ACTIVE, DEACTIVATED, DELETED."
},
"createdOn": {
"type": "string",
"description": "The timestamp when the meshLocation was created."
}
},
"description": "The lifecycle status of the meshLocation."
},
"isPublic": {
"type": "boolean",
"description": "Indicates whether the location has any public platform instances associated with it."
}
},
"description": "The current status of the meshLocation."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshBuildingBlockPostV2": {
"title": "meshBuildingBlockPostV2",
"required": [
"_links",
"apiVersion",
"kind",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block and the workspace it belongs to."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionVersionRef",
"displayName",
"inputs",
"parentBuildingBlocks",
"targetRef"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent Building Blocks, which are set on the Building Block.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"targetRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshTenant\""
},
"uuid": {
"type": "string",
"description": "The uuid of the tenant for this Building Block"
}
},
"description": "The reference to either a tenant or workspace the Building Block is located on."
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"updateableByConsumer",
"valueType"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data.",
"nullable": true
},
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether this input can be updated by the consumer."
},
"value": {
"type": "string",
"description": "The value of this input. For sensitive inputs, this is a SecretEmbedded object containing only a 'hash' field (plaintext is never returned in responses).",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the input as defined on the Building Block Definition.",
"nullable": true
}
}
}
},
"description": "Map of input keys to their input data."
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
},
"buildingBlockDefinitionVersionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockDefinitionVersion\""
},
"uuid": {
"type": "string",
"description": "The uuid of the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "The reference to the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "All fields in this section describe the Building Block."
},
"status": {
"required": [
"forcePurge",
"lifecycle",
"outputs",
"status"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the date when a user requested the deletion is provided via this field. e.g. `2020-12-22T09:37:43Z`",
"nullable": true
},
"deletedOn": {
"type": "string",
"description": "If the Building Block has been deleted, the date when it was deleted.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block. ACTIVE, MARKED_FOR_DELETION or DELETED."
},
"createdOn": {
"type": "string",
"description": "The date when the Building Block was created (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
}
},
"description": "Lifecycle information of the Building Block."
},
"outputs": {
"type": "object",
"description": "Always an empty map of output keys immediately after creation. Outputs are only available once the building block has been successfully executed. Poll the GET endpoint to retrieve outputs once the building block has reached status `SUCCEEDED`."
},
"forcePurge": {
"type": "boolean",
"description": "Indicates whether this building block was marked to be purged."
},
"latestRunUuid": {
"type": "string",
"description": "The UUID of the latest meshBuildingBlockRun for this Building Block. This field is null when the caller's permissions are not sufficient to view runs \u2014 for example, when the API key has workspace-scoped access only and the Building Block Definition does not have run transparency enabled.",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
},
"description": "All fields in this section describe the current status of the Building Block."
}
}
},
"meshBuildingBlockDefinitionListV1": {
"title": "meshBuildingBlockDefinitionListV1",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshBuildingBlockDefinitions"
],
"type": "object",
"properties": {
"meshBuildingBlockDefinitions": {
"type": "array",
"description": "List of meshBuildingBlockDefinitions.",
"items": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition.",
"nullable": true
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the Building Block Definition. Keep in mind, that values are an array.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition. It also contains additional meta information like the Building Block Definition creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this endpoint."
},
"spec": {
"required": [
"description",
"displayName",
"targetType",
"useInLandingZonesOnly"
],
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the Building Block Definition as it is shown in meshPanel.",
"nullable": true
},
"documentationUrl": {
"type": "string",
"description": "The URL pointing to documentation of the Building Block Definition. (optional)",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block Definition as it is shown in meshPanel."
},
"supportUrl": {
"type": "string",
"description": "The URL pointing to support of the Building Block Definition. (optional)",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the Building Block Definition as it is shown in meshPanel."
},
"targetType": {
"type": "string",
"description": "The type of Building Block Definition. (One of ['TENANT_LEVEL', 'WORKSPACE_LEVEL'.])"
},
"runTransparency": {
"type": "boolean",
"description": "Specifies the Building Block Definition run control. When set to true, both platform teams and workspace users can view detailed run logs and re-run building blocks. When set to false (default), only platform teams have this access.",
"nullable": true
},
"supportedPlatforms": {
"type": "array",
"description": "Set of the platform types this Building Block Definition supports. Must be non-empty if targetType is 'TENANT_LEVEL', otherwise null. Each entry is a meshPlatformType reference.",
"items": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object. Must be 'meshPlatformType'."
},
"name": {
"type": "string",
"description": "The unique identifier of the platform type (corresponds to the `metadata.name` of a meshPlatformType)."
}
}
}
},
"notificationSubscriberUsernames": {
"type": "array",
"description": "A set of usernames or emails that should be notified as subscribers for this Building Block Definition. Prefix entries with `user:` or `email:`.",
"nullable": true,
"items": {
"type": "string"
}
},
"useInLandingZonesOnly": {
"type": "boolean",
"description": "Indicates whether this Building Block Definition should be used on Landing Zones only."
}
},
"description": "All fields in this section describe the Building Block Definition."
},
"status": {
"required": [
"latestVersion",
"latestVersionUuid",
"lifecycle",
"versions"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the date when a user requested the deletion is provided via this field (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block Definition. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information about the Building Block Definition."
},
"latestReleasedVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"versions": {
"type": "array",
"description": "List of meshBuildingBlockDefinitionVersions, which exist for the Building Block Definition.",
"items": {
"required": [
"state",
"versionNumber",
"versionUuid"
],
"type": "object",
"properties": {
"versionUuid": {
"type": "string",
"description": "The uuid of the listed version."
},
"state": {
"type": "string",
"description": "The state of the listed version. (One of ['DRAFT', 'RELEASED'])"
},
"versionNumber": {
"type": "number",
"description": "The number of the listed version."
}
}
}
},
"latestReleasedVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"latestVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition including a possible draft version."
},
"usageCount": {
"type": "number",
"description": "The number of Building Blocks using this Building Block Definition.",
"nullable": true
},
"latestVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition including a possible draft version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshBuildingBlockRunDownloadLogs": {
"title": "meshBuildingBlockRunDownloadLogs",
"required": [
"steps"
],
"type": "object",
"properties": {
"steps": {
"type": "array",
"description": "List of steps in the building block run.",
"items": {
"required": [
"displayName",
"status"
],
"type": "object",
"properties": {
"userMessage": {
"type": "string",
"description": "A user-facing message for the step. Always included regardless of caller permissions.",
"nullable": true
},
"systemMessage": {
"type": "string",
"description": "A system/operator-facing message for the step. Included for admin or platform operator (managed) API keys, and for workspace-scoped callers when runTransparency is enabled. Null otherwise.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the step."
},
"status": {
"type": "string",
"description": "The execution status of the step. One of PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
}
}
}
}
},
"importInJson": {
"title": "importInJson",
"type": "object"
},
"api-meshobjects-meshprojects-600031310": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that should be unique within a workspace"
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that the project should belong to."
}
},
"description": "Fixed fields that help to identify the meshProject."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProject datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProject' for this endpoint."
},
"spec": {
"required": [
"displayName",
"tags"
],
"type": "object",
"properties": {
"substitutePaymentMethodIdentifier": {
"type": "string",
"description": "The substitute payment method of the project.",
"nullable": true
},
"paymentMethodIdentifier": {
"type": "string",
"description": "The payment method of the project.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the project as it is shown in meshPanel."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the project. Keep in mind, that values are an array."
}
},
"description": "All fields in this section describe the project."
}
}
},
"meshProjectListV2": {
"title": "meshProjectListV2",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshProjects"
],
"type": "object",
"properties": {
"meshProjects": {
"type": "array",
"description": "List of meshProjects.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshusers-username-179515684": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username as 'name' to uniquely identify the meshUser."
}
},
"description": "Always contains the 'name' to uniquely identify the meshUser."
},
"apiVersion": {
"type": "string",
"description": "Version of meshUser datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshUser' for this endpoint."
},
"spec": {
"required": [
"email",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"lastName": {
"type": "string",
"description": "The last name of the meshUser."
},
"firstName": {
"type": "string",
"description": "The first name of the meshUser."
},
"euid": {
"type": "string",
"description": "External User ID which is used to lookup the user in the cloud platforms.",
"nullable": true
},
"email": {
"type": "string",
"description": "The email of the meshUser."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshUser. Keep in mind, that values are an array.",
"nullable": true
}
},
"description": "All fields in this section describe the meshUser."
}
}
},
"api-login2002944754": {
"required": [
"client_id",
"client_secret",
"grant_type"
],
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"description": "The grant type, which must be 'client_credentials'."
},
"client_secret": {
"type": "string",
"description": "The Key Secret associated with your API key. This secret is used in conjunction with the client_id to securely authenticate your application."
},
"client_id": {
"type": "string",
"description": "The Key ID assigned to your API key upon creation. This ID is used to authenticate your application."
}
}
},
"meshApiKey-Get": {
"title": "meshApiKey-Get",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"description": "Timestamp when the API key was created (ISO-8601 instant format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "UUID of the API key.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "Identifier of the workspace that owns this API key."
}
},
"description": "Metadata that identifies and scopes the meshApiKey."
},
"apiVersion": {
"type": "string",
"description": "Version of meshApiKey datatype. For this endpoint this is always 'v1-preview'."
},
"_links": {
"type": "object",
"description": "Available links on a meshApiKey."
},
"kind": {
"type": "string",
"description": "The meshObject kind. For this endpoint this is always 'meshApiKey'."
},
"spec": {
"required": [
"displayName",
"permissions"
],
"type": "object",
"properties": {
"permissions": {
"type": "array",
"description": "Set of permission short-codes assigned to this API key.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"displayName": {
"type": "string",
"description": "Display name of the API key."
},
"expiresAt": {
"type": "string",
"description": "Expiration date of the API key (ISO-8601 date format, e.g. 2025-12-31). Nullable if the key does not expire.",
"nullable": true
}
},
"description": "Configuration of the meshApiKey."
},
"status": {
"required": [
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The clientId used for authentication. Same as metadata.uuid."
},
"clientSecret": {
"type": "string",
"description": "The clientSecret used for authentication. Only included on creation (POST) or when the secret is rotated due to an expiresAt change (PUT). Omitted on GET.",
"nullable": true
}
},
"description": "Status information including clientId and the clientSecret (only on creation or key rotation)."
}
}
},
"meshWorkspaceUserBinding": {
"title": "meshWorkspaceUserBinding",
"required": [
"_links",
"apiVersion",
"kind",
"metadata"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the workspace the user is assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the workspace the user is assigned to."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The meshWorkspaceUserBinding identifier as 'name' to uniquely identify the meshWorkspaceUserBinding."
}
},
"description": "Always contains the 'name' to uniquely identify the meshWorkspaceUserBinding."
},
"apiVersion": {
"type": "string",
"description": "Version of meshWorkspaceUserBinding datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username of the referenced user."
}
}
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshWorkspaceUserBinding' for this endpoint."
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this user."
}
}
}
}
},
"api-meshobjects-meshworkspacebindings-groupbindings-439969197": {
"required": [
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the workspace the group should get assigned to."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of this binding which later can be used to refer to it. It must be globally unique."
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of this object"
},
"kind": {
"type": "string",
"description": "Type of the returned meshObject"
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the referenced workspace user group."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the role for this workspace user group."
}
}
}
}
},
"meshPlatform-Get-V2-azurerg": {
"title": "meshPlatform-Get-V2-azurerg",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef",
"quotaDefinitions"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"accessInformation": {
"type": "string",
"description": "Optional access information note in Markdown format shown to platform consumers.",
"nullable": true
},
"quotaDefinitions": {
"type": "array",
"description": "List of platform quota definitions. Quota definitions define the available quotas that can be configured for tenants on this platform. Currently only supported for platform types: OPENSHIFT, KUBERNETES, AZURE_KUBERNETES_SERVICE, CLOUDFOUNDRY, OPENSTACK. For platforms that don't support it yet, you have to provide an empty array. If empty list is provided, all existing quota definitions are removed.",
"items": {
"required": [
"autoApprovalThreshold",
"description",
"label",
"maxValue",
"minValue",
"quotaKey"
],
"type": "object",
"properties": {
"quotaKey": {
"type": "string",
"description": "The key of the quota as it is required by the cloud platform."
},
"minValue": {
"type": "number",
"description": "Minimum allowed value for this quota."
},
"unit": {
"type": "string",
"description": "Unit of measurement for the quota (e.g., 'cores', 'GB', 'requests'). Must match the unit expected by the cloud platform.",
"nullable": true
},
"autoApprovalThreshold": {
"type": "number",
"description": "Threshold below which quota requests are automatically approved."
},
"maxValue": {
"type": "number",
"description": "Maximum allowed value for this quota."
},
"description": {
"type": "string",
"description": "Detailed description of what this quota controls."
},
"label": {
"type": "string",
"description": "Human-readable label for the quota."
}
}
}
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
},
"name": {
"type": "string",
"description": "The identifier of the location."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"publicationState",
"restriction"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"readme": {
"type": "string",
"description": "README about the meshPlatform in markdown format",
"nullable": true
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client config for metering"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Kubernetes configuration, if applicable."
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"gcpRoleMappings",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"serviceAccount",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"gcpRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"gcpRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"gcpRole": {
"type": "string",
"description": "GCP role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP API access"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
},
"metering": {
"required": [
"bigqueryTable",
"partitionTimeColumn",
"processing",
"serviceAccount"
],
"type": "object",
"properties": {
"partitionTimeColumn": {
"type": "string",
"description": "Column name for partitioning time-based data"
},
"additionalFilter": {
"type": "string",
"description": "Additional SQL filter for billing data (optional)",
"nullable": true
},
"bigqueryTableForCarbonFootprint": {
"type": "string",
"description": "BigQuery table containing carbon footprint data (optional)",
"nullable": true
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"carbonFootprintDataCollectionStartMonth": {
"type": "string",
"description": "Start month for carbon footprint data collection (optional)",
"nullable": true
},
"bigqueryTable": {
"type": "string",
"description": "BigQuery table containing billing data export"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account for metering, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider for metering access."
}
},
"description": "Service account workload identity configuration for metering (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for metering service account. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP metering API access"
}
},
"description": "Metering configuration for GCP (optional, but required for metering)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Azure Resource Group configuration, if applicable."
},
"custom": {
"required": [
"platformTypeRef"
],
"type": "object",
"properties": {
"platformTypeRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this ref."
},
"name": {
"type": "string",
"description": "Identifier of the custom platform type"
}
},
"description": "Reference to the specific custom platform type to use"
},
"metering": {
"required": [
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for custom platforms"
}
},
"description": "Custom platform configuration, if applicable."
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"openshiftRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"openshiftRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"openshiftRole": {
"type": "string",
"description": "OpenShift role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identifier of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Access token for Kubernetes API authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Kubernetes client configuration for metering access"
}
},
"description": "Metering configuration for OpenShift (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Openshift configuration, if applicable."
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of AKS authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator EntraID access to manage groups that are used for RBAC in the AKS cluster."
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the Kubernetes service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"metering": {
"required": [
"clientConfig"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
}
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Replication configuration for AKS (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Azure Kubernetes Service configuration, if applicable."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"accountNamePattern": {
"type": "string",
"description": "Defines the pattern for the AWS account name. If none provided, uses default of '#{workspaceIdentifier}.#{projectIdentifier}'.",
"nullable": true
},
"awsIdentityStore": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"identityStoreId",
"signInUrl"
],
"type": "object",
"properties": {
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign-in URL that end-users must use to log in to the AWS Management Console via AWS IAM Identity Center."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS IAM Identity Center permission set.",
"items": {
"required": [
"awsRole",
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"awsRole": {
"type": "string",
"description": "The name of the AWS role alias used as a suffix in the group name pattern."
},
"permissionSetArns": {
"type": "array",
"description": "The ARNs of the AWS IAM Identity Center permission sets to assign to the group. At least one permission set ARN is required.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
},
"identityStoreId": {
"type": "string",
"description": "The ID of the AWS IAM Identity Center Identity Store associated with this instance. E.g. d-1234567890. You can find this in the AWS IAM Identity Center console."
}
},
"description": "AWS IAM Identity Center integration using the AWS Identity Store API. This is an alternative to the SCIM-based awsSso integration that requires no long-lived SCIM bearer token and is fully compatible with Workload Identity Federation (WIF). Only one of awsSso or awsIdentityStore may be configured at a time. If neither is configured, IAM/group replication is disabled (IAM type 'None')."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later. "
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role. ",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys."
},
"awsSso": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The AWS IAM Identity Center SCIM Access Token. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS role.",
"items": {
"required": [
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration. Configure this to use the legacy SCIM-based IAM integration. Leave both awsSso and awsIdentityStore unset to disable IAM/group replication (IAM type 'None')."
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"metering": {
"required": [
"accessConfig",
"filter",
"processing",
"reservedInstanceFairChargeback",
"savingsPlanFairChargeback"
],
"type": "object",
"properties": {
"filter": {
"type": "string",
"description": "Cost Explorer filter type. NONE includes all costs, EXCLUDE_TAX filters out tax charges."
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role for metering access."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role for metering access via workload identity federation"
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for metering service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for metering service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS metering access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId for enhanced security when assuming the organization root account role for metering.",
"nullable": true
}
},
"description": "AWS access configuration for metering"
},
"savingsPlanFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for savings plans"
},
"reservedInstanceFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for reserved instances"
}
},
"description": "Metering configuration for AWS (optional, but required for metering)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "AWS configuration, if applicable."
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"azureRoleMappings",
"groupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"updateSubscriptionName",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"azureRoleMappings": {
"type": "array",
"description": "Role mappings for Azure with project role references",
"items": {
"required": [
"azureRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRole": {
"required": [
"alias",
"id"
],
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "Alias for the Azure role"
},
"id": {
"type": "string",
"description": "ID of the Azure role"
}
},
"description": "Azure role"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"updateSubscriptionName": {
"type": "boolean",
"description": "Configures whether subscription names should be updated to match the subscription name pattern during replication."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"auth",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure Graph API authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the source service principal for replicator access to a customer agreement. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
},
"metering": {
"required": [
"processing",
"servicePrincipal"
],
"type": "object",
"properties": {
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Client ID of the service principal for metering"
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "Object ID of the service principal for metering"
}
},
"description": "Service principal configuration for metering access"
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for Azure (optional, but required for metering)"
}
},
"description": "Azure configuration, if applicable."
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"availability",
"lifecycle",
"metering"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the platform was deleted. Only present if the platform has been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "Lifecycle state of the platform. Possible values: ACTIVE, DEACTIVATED, MARKED_FOR_DELETION, DELETED."
}
},
"description": "Lifecycle state information of the platform."
},
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"availability": {
"required": [
"publicationState"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace. Possible values: UNPUBLISHED, PUBLISHED, REQUESTED, REJECTED"
}
},
"description": "Marketplace availability and publication status information."
}
},
"description": "Current status information of the meshPlatform."
}
}
},
"api-meshobjects-meshcommunications-1284413466": {
"required": [
"apiVersion",
"kind",
"spec"
],
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"description": "Version of Communication datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshCommunication' for this endpoint."
},
"spec": {
"required": [
"communicationDefinitionRef",
"targetMeshObjectRef"
],
"type": "object",
"properties": {
"communicationDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshCommunicationDefinition\""
},
"uuid": {
"type": "string",
"description": "The UUID of the communication definition associated with this communication."
}
},
"description": "Reference to the associated communication definition."
},
"targetMeshObjectRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The type of mesh object being targeted. Supported values are: `meshWorkspace`, `meshTenant`, and `meshBuildingBlock`."
},
"name": {
"type": "string",
"description": "An identifier or UUID that uniquely identifies the referenced meshObject. The required format depends on the `kind` of the target:\nFor kind `meshWorkspace`, use the workspace identifier.\nFor kind `meshTenant`, use the tenant UUID.\nFor kind `meshBuildingBlock`, use the building block UUID."
}
},
"description": "describes which meshObject is targeted."
}
},
"description": "All fields in this section describe the Communication."
}
}
},
"api-meshobjects-meshplatforms-uuid-453116572": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"identifier",
"kind"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the location."
},
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"marketplaceStatus",
"restriction"
],
"type": "object",
"properties": {
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"marketplaceStatus": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for Kubernetes"
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"roleMappings",
"serviceAccountConfig",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"serviceAccountConfig": {
"type": "object",
"properties": {
"serviceAccountCredentialsConfig": {
"required": [
"serviceAccountCredentialsB64"
],
"type": "object",
"properties": {
"serviceAccountCredentialsB64": {
"type": "string",
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. The replicator uses this Service Account to automate GCP API operations (IAM, ResourceManager etc.)."
}
},
"description": "Service account credentials configuration (alternative to serviceAccountWorkloadIdentityConfig)"
},
"serviceAccountWorkloadIdentityConfig": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (alternative to serviceAccountCredentialsConfig)"
}
},
"description": "Service account configuration. Either serviceAccountCredentialsConfig or serviceAccountWorkloadIdentityConfig must be provided."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for GCP"
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application"
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure Resource Group"
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for OpenShift"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret for the service principal (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type for the service principal (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for AKS"
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Configuration for Azure Kubernetes Service (AKS)"
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"workloadIdentityConfig": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (alternative to serviceUserConfig)"
},
"serviceUserConfig": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "string",
"description": "AWS secret key for service user"
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user configuration (alternative to workloadIdentityConfig)"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role.",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys. Either the `serviceUserConfig` or `workloadIdentityConfig` must be provided."
},
"awsSso": {
"required": [
"arn",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "string",
"description": "The AWS IAM Identity Center SCIM Access Token that was generated via the Automatic provisioning config in AWS IAM Identity Center."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"roleMappings": {
"type": "object",
"properties": {
"member": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for member role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for member role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"admin": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for admin role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for admin role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"description": "Role mappings for AWS SSO"
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration"
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "Configuration for AWS"
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"groupNamePattern",
"roleMappings",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"roleMappings": {
"type": "object",
"description": "Role mappings for Azure"
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"authType",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Must be set if and only if `authType` is `CREDENTIALS`. A valid secret for accessing the application. In Azure Portal, this can be configured on the \"App Registration\" under Certificates & secrets. https://docs.meshcloud.io/operations/security-faq/#how-does-meshstack-securely-handle-my-cloud-platform-credentials[How is this information secured?]",
"nullable": true
},
"authType": {
"type": "string",
"description": "Must be one of `CREDENTIALS` or `WORKLOAD_IDENTITY`. Workload Identity Federation is the one that we recommend as it enables the most secure approach to provide access to your Azure tenant without using long lived credentials. Credential Authentication is an alternative approach where you have to provide a clientSecret manually to meshStack and meshStack stores it encrypted."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure"
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
}
}
},
"meshUserV2Put": {
"title": "meshUserV2Put",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username as 'name' to uniquely identify the meshUser."
},
"uuid": {
"type": "string",
"description": "A unique identifier (UUID) for the meshUser.",
"nullable": true
}
},
"description": "Always contains the 'name' to uniquely identify the meshUser."
},
"apiVersion": {
"type": "string",
"description": "Version of meshUser datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshUser."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshUser' for this endpoint."
},
"spec": {
"required": [
"email",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"lastName": {
"type": "string",
"description": "The last name of the meshUser."
},
"firstName": {
"type": "string",
"description": "The first name of the meshUser."
},
"euid": {
"type": "string",
"description": "External User ID which is used to lookup the user in the cloud platforms.",
"nullable": true
},
"email": {
"type": "string",
"description": "The email of the meshUser."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshUser. Keep in mind, that values are an array.",
"nullable": true
}
},
"description": "All fields in this section describe the meshUser."
}
}
},
"meshPaymentMethodV2Put": {
"title": "meshPaymentMethodV2Put",
"type": "object"
},
"meshWorkspacePut": {
"title": "meshWorkspacePut",
"type": "object"
},
"meshCommunicationDefinitionList": {
"title": "meshCommunicationDefinitionList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshCommunicationDefinitions"
],
"type": "object",
"properties": {
"meshCommunicationDefinitions": {
"type": "array",
"description": "Filtered list of definitions.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "The container for the result set."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshPaymentMethodListV2": {
"title": "meshPaymentMethodListV2",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshPaymentMethods"
],
"type": "object",
"properties": {
"meshPaymentMethods": {
"type": "array",
"description": "List of meshPaymentMethods.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshtenants-1387214899": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The identifier of the meshProject the meshTenant belongs to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the meshTenant belongs to."
}
},
"description": "Fixed fields that help identify the Tenant."
},
"apiVersion": {
"type": "string",
"description": "Version of Tenant datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshTenant' for this endpoint."
},
"spec": {
"required": [
"platformIdentifier"
],
"type": "object",
"properties": {
"platformTenantId": {
"type": "string",
"description": "The platform tenant id assigned by the platform for this meshTenant. If set, meshStack will import an existing tenant from the cloud platform instead of creating a new one. Only API Keys or API Users with admin permissions for saving tenants can set this field.",
"nullable": true
},
"landingZoneIdentifier": {
"type": "string",
"description": "The identifier of the landing zone the meshTenant belongs to. Required for tenants of all platforms except service registries (OSB marketplaces).",
"nullable": true
},
"platformIdentifier": {
"type": "string",
"description": "The identifier of the platform the meshTenant belongs to."
}
},
"description": "All fields in this section describe the Tenant."
}
}
},
"meshPlatform-Put-V2-kubernetes": {
"title": "meshPlatform-Put-V2-kubernetes",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef",
"quotaDefinitions"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"accessInformation": {
"type": "string",
"description": "Optional access information note in Markdown format shown to platform consumers.",
"nullable": true
},
"quotaDefinitions": {
"type": "array",
"description": "List of platform quota definitions. Quota definitions define the available quotas that can be configured for tenants on this platform. Currently only supported for platform types: OPENSHIFT, KUBERNETES, AZURE_KUBERNETES_SERVICE, CLOUDFOUNDRY, OPENSTACK. For platforms that don't support it yet, you have to provide an empty array. If empty list is provided, all existing quota definitions are removed.",
"items": {
"required": [
"autoApprovalThreshold",
"description",
"label",
"maxValue",
"minValue",
"quotaKey"
],
"type": "object",
"properties": {
"quotaKey": {
"type": "string",
"description": "The key of the quota as it is required by the cloud platform."
},
"minValue": {
"type": "number",
"description": "Minimum allowed value for this quota."
},
"unit": {
"type": "string",
"description": "Unit of measurement for the quota (e.g., 'cores', 'GB', 'requests'). Must match the unit expected by the cloud platform.",
"nullable": true
},
"autoApprovalThreshold": {
"type": "number",
"description": "Threshold below which quota requests are automatically approved."
},
"maxValue": {
"type": "number",
"description": "Maximum allowed value for this quota."
},
"description": {
"type": "string",
"description": "Detailed description of what this quota controls."
},
"label": {
"type": "string",
"description": "Human-readable label for the quota."
}
}
}
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
},
"name": {
"type": "string",
"description": "The identifier of the location."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"publicationState",
"restriction"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"readme": {
"type": "string",
"description": "README about the meshPlatform in markdown format",
"nullable": true
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client config for metering"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Kubernetes configuration, if applicable."
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"gcpRoleMappings",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"serviceAccount",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"gcpRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"gcpRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"gcpRole": {
"type": "string",
"description": "GCP role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP API access"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
},
"metering": {
"required": [
"bigqueryTable",
"partitionTimeColumn",
"processing",
"serviceAccount"
],
"type": "object",
"properties": {
"partitionTimeColumn": {
"type": "string",
"description": "Column name for partitioning time-based data"
},
"additionalFilter": {
"type": "string",
"description": "Additional SQL filter for billing data (optional)",
"nullable": true
},
"bigqueryTableForCarbonFootprint": {
"type": "string",
"description": "BigQuery table containing carbon footprint data (optional)",
"nullable": true
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"carbonFootprintDataCollectionStartMonth": {
"type": "string",
"description": "Start month for carbon footprint data collection (optional)",
"nullable": true
},
"bigqueryTable": {
"type": "string",
"description": "BigQuery table containing billing data export"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account for metering, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider for metering access."
}
},
"description": "Service account workload identity configuration for metering (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for metering service account. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP metering API access"
}
},
"description": "Metering configuration for GCP (optional, but required for metering)"
}
},
"description": "GCP configuration, if applicable."
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Azure Resource Group configuration, if applicable."
},
"custom": {
"required": [
"platformTypeRef"
],
"type": "object",
"properties": {
"platformTypeRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this ref."
},
"name": {
"type": "string",
"description": "Identifier of the custom platform type"
}
},
"description": "Reference to the specific custom platform type to use"
},
"metering": {
"required": [
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for custom platforms"
}
},
"description": "Custom platforms don't have a replicator configuration and only support defining a platformType and basic metering."
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"openshiftRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"openshiftRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"openshiftRole": {
"type": "string",
"description": "OpenShift role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identifier of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Access token for Kubernetes API authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Kubernetes client configuration for metering access"
}
},
"description": "Metering configuration for OpenShift (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Openshift configuration, if applicable."
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of AKS authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator EntraID access to manage groups that are used for RBAC in the AKS cluster."
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the Kubernetes service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"metering": {
"required": [
"clientConfig"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
}
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Replication configuration for AKS (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Azure Kubernetes Service configuration, if applicable."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"accountNamePattern": {
"type": "string",
"description": "Defines the pattern for the AWS account name. If none provided, uses default of '#{workspaceIdentifier}.#{projectIdentifier}'.",
"nullable": true
},
"awsIdentityStore": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"identityStoreId",
"signInUrl"
],
"type": "object",
"properties": {
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign-in URL that end-users must use to log in to the AWS Management Console via AWS IAM Identity Center."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS IAM Identity Center permission set.",
"items": {
"required": [
"awsRole",
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"awsRole": {
"type": "string",
"description": "The name of the AWS role alias used as a suffix in the group name pattern."
},
"permissionSetArns": {
"type": "array",
"description": "The ARNs of the AWS IAM Identity Center permission sets to assign to the group. At least one permission set ARN is required.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
},
"identityStoreId": {
"type": "string",
"description": "The ID of the AWS IAM Identity Center Identity Store associated with this instance. E.g. d-1234567890. You can find this in the AWS IAM Identity Center console."
}
},
"description": "AWS IAM Identity Center integration using the AWS Identity Store API. This is an alternative to the SCIM-based awsSso integration that requires no long-lived SCIM bearer token and is fully compatible with Workload Identity Federation (WIF). Only one of awsSso or awsIdentityStore may be configured at a time. If neither is configured, IAM/group replication is disabled (IAM type 'None')."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later. "
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role. ",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys."
},
"awsSso": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The AWS IAM Identity Center SCIM Access Token. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS role.",
"items": {
"required": [
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration. Configure this to use the legacy SCIM-based IAM integration. Leave both awsSso and awsIdentityStore unset to disable IAM/group replication (IAM type 'None')."
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"metering": {
"required": [
"accessConfig",
"filter",
"processing",
"reservedInstanceFairChargeback",
"savingsPlanFairChargeback"
],
"type": "object",
"properties": {
"filter": {
"type": "string",
"description": "Cost Explorer filter type. NONE includes all costs, EXCLUDE_TAX filters out tax charges."
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role for metering access."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role for metering access via workload identity federation"
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for metering service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for metering service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS metering access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId for enhanced security when assuming the organization root account role for metering.",
"nullable": true
}
},
"description": "AWS access configuration for metering"
},
"savingsPlanFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for savings plans"
},
"reservedInstanceFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for reserved instances"
}
},
"description": "Metering configuration for AWS (optional, but required for metering)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "AWS configuration, if applicable."
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"azureRoleMappings",
"groupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"updateSubscriptionName",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"azureRoleMappings": {
"type": "array",
"description": "Role mappings for Azure with project role references",
"items": {
"required": [
"azureRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRole": {
"required": [
"alias",
"id"
],
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "Alias for the Azure role"
},
"id": {
"type": "string",
"description": "ID of the Azure role"
}
},
"description": "Azure role"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"updateSubscriptionName": {
"type": "boolean",
"description": "Configures whether subscription names should be updated to match the subscription name pattern during replication."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"auth",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure Graph API authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the source service principal for replicator access to a customer agreement. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
},
"metering": {
"required": [
"processing",
"servicePrincipal"
],
"type": "object",
"properties": {
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Client ID of the service principal for metering"
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "Object ID of the service principal for metering"
}
},
"description": "Service principal configuration for metering access"
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for Azure (optional, but required for metering)"
}
},
"description": "Azure configuration, if applicable."
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"availability",
"lifecycle",
"metering"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the platform was deleted. Only present if the platform has been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "Lifecycle state of the platform. Possible values: ACTIVE, DEACTIVATED, MARKED_FOR_DELETION, DELETED."
}
},
"description": "Lifecycle state information of the platform."
},
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"availability": {
"required": [
"publicationState"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace. Possible values: UNPUBLISHED, PUBLISHED, REQUESTED, REJECTED"
}
},
"description": "Marketplace availability and publication status information."
}
},
"description": "Current status information of the meshPlatform."
}
}
},
"meshPlatformTypeV1Post": {
"title": "meshPlatformTypeV1Post",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshPlatformType."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshPlatformType across all platform types.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that owns this platform type."
}
},
"description": "Contains the identifiers for the meshPlatformType."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatformType datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshPlatformType."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this endpoint."
},
"spec": {
"required": [
"category",
"displayName",
"icon"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshPlatformType shown in the UI."
},
"icon": {
"type": "string",
"description": "The icon used to display the platform type in the UI. This must be provided as a base64 encoded data image. Size should be kept small to ensure fast loading times and efficient storage."
},
"defaultEndpoint": {
"type": "string",
"description": "The default endpoint URL for the platform type. This will be used as a default value when creating platform instances. The default endpoint should be a link to a web portal of the cloud platform for example.",
"nullable": true
},
"category": {
"type": "string",
"description": "The platform category. For custom platform types, this is always 'CUSTOM'. Possible values: OPENSTACK, CLOUDFOUNDRY, SERVICEREGISTRY, AWS, OPENSHIFT, KUBERNETES, AZURE, GCP, AZURE_KUBERNETES_SERVICE, AZURE_RESOURCE_GROUP, CUSTOM, GITHUB."
}
},
"description": "All fields in this section describe the meshPlatformType configuration."
},
"status": {
"required": [
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The lifecycle state of the platform type. Can be 'ACTIVE' or 'DEACTIVATED'. Deactivated platform types cannot be used to create new platform instances."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the meshPlatformType was created.",
"nullable": true
}
},
"description": "The lifecycle information of the platform type."
}
},
"description": "The current status of the meshPlatformType."
}
}
},
"meshUserV2Post": {
"title": "meshUserV2Post",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username as 'name' to uniquely identify the meshUser."
},
"uuid": {
"type": "string",
"description": "A unique identifier (UUID) for the meshUser.",
"nullable": true
}
},
"description": "Always contains the 'name' to uniquely identify the meshUser."
},
"apiVersion": {
"type": "string",
"description": "Version of meshUser datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshUser."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshUser' for this endpoint."
},
"spec": {
"required": [
"email",
"firstName",
"lastName"
],
"type": "object",
"properties": {
"lastName": {
"type": "string",
"description": "The last name of the meshUser."
},
"firstName": {
"type": "string",
"description": "The first name of the meshUser."
},
"euid": {
"type": "string",
"description": "External User ID which is used to lookup the user in the cloud platforms.",
"nullable": true
},
"email": {
"type": "string",
"description": "The email of the meshUser."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshUser. Keep in mind, that values are an array.",
"nullable": true
}
},
"description": "All fields in this section describe the meshUser."
}
}
},
"meshPlatformTypeV1Put": {
"title": "meshPlatformTypeV1Put",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshPlatformType."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshPlatformType across all platform types.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that owns this platform type."
}
},
"description": "Contains the identifiers for the meshPlatformType."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatformType datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshPlatformType."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this endpoint."
},
"spec": {
"required": [
"category",
"displayName",
"icon"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshPlatformType shown in the UI."
},
"icon": {
"type": "string",
"description": "The icon used to display the platform type in the UI. This must be provided as a base64 encoded data image. Size should be kept small to ensure fast loading times and efficient storage."
},
"defaultEndpoint": {
"type": "string",
"description": "The default endpoint URL for the platform type. This will be used as a default value when creating platform instances. The default endpoint should be a link to a web portal of the cloud platform for example.",
"nullable": true
},
"category": {
"type": "string",
"description": "The platform category. For custom platform types, this is always 'CUSTOM'. Possible values: OPENSTACK, CLOUDFOUNDRY, SERVICEREGISTRY, AWS, OPENSHIFT, KUBERNETES, AZURE, GCP, AZURE_KUBERNETES_SERVICE, AZURE_RESOURCE_GROUP, CUSTOM, GITHUB."
}
},
"description": "All fields in this section describe the meshPlatformType configuration."
},
"status": {
"required": [
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The lifecycle state of the platform type. Can be 'ACTIVE' or 'DEACTIVATED'. Deactivated platform types cannot be used to create new platform instances."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the meshPlatformType was created.",
"nullable": true
}
},
"description": "The lifecycle information of the platform type."
}
},
"description": "The current status of the meshPlatformType."
}
}
},
"meshServiceInstancePost": {
"title": "meshServiceInstancePost",
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"instanceId",
"marketplaceIdentifier",
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The project that this Service Instance belongs to."
},
"marketplaceIdentifier": {
"type": "string",
"description": "The identifier of the marketplace that this Service Instance belongs to."
},
"instanceId": {
"type": "string",
"description": "The instance id this Service Instance should use."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that this Service Instance belongs to."
}
},
"description": "Metadata and more fields to identify the Service Instance."
},
"apiVersion": {
"type": "string",
"description": "Version of Service Instance datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"creator",
"displayName",
"planId",
"serviceId"
],
"type": "object",
"properties": {
"creator": {
"type": "string",
"description": "The meshUser's `username` that should be passed to the Open Service Broker via the `X-Broker-API-Originating-Identity` header."
},
"displayName": {
"type": "string",
"description": "The display name of the Service Instance."
},
"planId": {
"type": "string",
"description": "The id of the plan for this Service Instance"
},
"serviceId": {
"type": "string",
"description": "The id of the service for the Service Instance"
},
"parameters": {
"type": "object",
"description": "Parameters to pass to the Service Broker when provisioning the service instance. The structure and content of this field is defined by the service broker.",
"nullable": true
},
"serviceBrokerIdentifier": {
"type": "string",
"description": "The identifier of the Service Broker managing this Service Instance.",
"nullable": true
}
},
"description": "Specifications for the Service Instance."
}
}
},
"meshBuildingBlockRunGet": {
"title": "meshBuildingBlockRunGet",
"required": [
"_links",
"apiVersion",
"kind",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID of this building block run."
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of meshBuildingBlockRun datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshBuildingBlockRun."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockRun' for this endpoint."
},
"spec": {
"required": [
"behavior",
"runNumber",
"runToken"
],
"type": "object",
"properties": {
"buildingBlock": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID of the referenced building block."
},
"spec": {
"required": [
"displayName",
"fullPlatformIdentifier",
"inputs",
"parentBuildingBlocks",
"projectIdentifier",
"workspaceIdentifier"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "A list of parent building blocks UUIDs for this building block.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"fullPlatformIdentifier": {
"type": "string",
"description": "The full identifier of the platform of the building block."
},
"inputs": {
"type": "array",
"description": "Contains the filled in input objects for this building block run.",
"items": {
"required": [
"isEnvironment",
"isSensitive",
"key",
"type",
"value"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean",
"description": "Flag if the variable content is sensitive and encrypted. The runner must decrypt this variable content first before it can be used."
},
"isEnvironment": {
"type": "boolean",
"description": "Flag if this variable should be provided as environment variable instead of getting handled as a 'native' variable for the chosen runner technology (for example a Terraform input)."
},
"type": {
"type": "string",
"description": "The type of the variable. One of STRING, CODE, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value of this variable."
},
"key": {
"type": "string",
"description": "The name of the input variable."
}
}
}
},
"displayName": {
"type": "string",
"description": "Display name of the building block."
},
"workspaceIdentifier": {
"type": "string",
"description": "The identifier of the workspace of the building block."
},
"projectIdentifier": {
"type": "string",
"description": "The identifier of the project of the building block."
}
}
}
}
},
"runToken": {
"type": "string",
"description": "JWT token that can be used by the runner to authenticate when calling back to meshStack to report status updates for this run. This token is scoped the the building block definition owner so it can only be used to update the run related steps/status or source registrations."
},
"buildingBlockDefinition": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID of the building block definition."
},
"spec": {
"required": [
"implementation",
"version",
"workspaceIdentifier"
],
"type": "object",
"properties": {
"implementation": {
"type": "object",
"description": "Contains information about the used implementation e.g. Terraform specific details of the building block."
},
"workspaceIdentifier": {
"type": "string",
"description": "The identifier of the workspace that owns the building block definition."
},
"version": {
"type": "number",
"description": "Version of the building block definition."
}
}
}
}
},
"runNumber": {
"type": "number",
"description": "Every run has a monotonically increasing number."
},
"behavior": {
"type": "string",
"description": "The behavior the runner should execute. One of APPLY, DETECT, DESTROY."
}
},
"description": "All fields in this section describe the meshBuildingBlockRun."
},
"status": {
"type": "string",
"description": "The current execution status of this building block run."
}
}
},
"api-meshobjects-meshapikeys1956798473": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByWorkspace": {
"type": "string",
"description": "Identifier of the workspace that owns this API key."
}
},
"description": "Metadata that identifies and scopes the meshApiKey."
},
"apiVersion": {
"type": "string",
"description": "Version of meshApiKey datatype. For this endpoint this is always 'v1-preview'."
},
"kind": {
"type": "string",
"description": "The meshObject kind. For this endpoint this is always 'meshApiKey'."
},
"spec": {
"required": [
"displayName",
"permissions"
],
"type": "object",
"properties": {
"permissions": {
"type": "array",
"description": "Set of permission short-codes assigned to this API key.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"displayName": {
"type": "string",
"description": "Display name of the API key."
},
"expiresAt": {
"type": "string",
"description": "Expiration date of the API key (ISO-8601 date format, e.g. 2025-12-31). Nullable if the key does not expire.",
"nullable": true
}
},
"description": "Configuration of the meshApiKey."
}
}
},
"meshIntegration-Put-github": {
"title": "meshIntegration-Put-github",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the integration across all integrations.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace identifier that owns this integration."
}
},
"description": "Contains identifiers and ownership information for the integration."
},
"apiVersion": {
"type": "string",
"description": "Version of meshIntegration datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshIntegration."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshIntegration' for this endpoint."
},
"spec": {
"required": [
"config",
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the integration."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"github": {
"required": [
"appId",
"appPrivateKey",
"baseUrl",
"owner",
"runnerRef"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The GitHub organization or user that owns the repositories."
},
"baseUrl": {
"type": "string",
"description": "The base URL of the GitHub API. Use 'https://api.github.com' for GitHub.com or your GitHub Enterprise URL."
},
"appPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The GitHub App private key for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"appId": {
"type": "string",
"description": "The GitHub App ID for authentication."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitHub-specific integration configuration."
},
"entraid": {
"required": [
"clientId",
"clientSecret",
"tenantId"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "The redirect URL to configure in the Entra Id app registration. This field is read-only and computed by the system.",
"nullable": true
},
"clientId": {
"type": "string",
"description": "The application (client) Id registered in the Entra Id tenant."
},
"tenantId": {
"type": "string",
"description": "The Microsoft Entra Id (Azure AD) tenant Id."
},
"clientSecret": {
"type": "object",
"description": "The client secret for authenticating with the Entra Id application. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Entra Id-specific integration configuration."
},
"azuredevops": {
"required": [
"baseUrl",
"organization",
"personalAccessToken",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the Azure DevOps instance. Typically 'https://dev.azure.com' for Azure DevOps Services."
},
"organization": {
"type": "string",
"description": "The Azure DevOps organization name."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
},
"personalAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Personal Access Token (PAT) for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Azure DevOps-specific integration configuration."
},
"gitlab": {
"required": [
"baseUrl",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the GitLab instance. Use 'https://gitlab.com' for GitLab.com or your self-hosted GitLab URL."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitLab-specific integration configuration."
},
"type": {
"type": "string",
"description": "The type of integration. Available types are: 'azuredevops','entraid','github','gitlab','metering','replicator'. EntraId integrations are only available for the admin workspace."
}
},
"description": "Integration configuration. Contains a 'type' field that determines the integration type ('azuredevops','entraid','github','gitlab','metering','replicator') and type-specific properties nested under the corresponding key (e.g., 'github', 'gitlab', 'azuredevops')."
}
},
"description": "All fields in this section describe the integration configuration."
},
"status": {
"required": [
"isBuiltIn",
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the integration. For meshIntegration, only ACTIVE is supported."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the integration was created. This field is automatically set by the system and cannot be modified.",
"nullable": true
}
},
"description": "Lifecycle information of the integration."
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "GCP Workload Identity Pool audience for token exchange."
}
},
"description": "Google Cloud Platform specific WIF configuration."
},
"subject": {
"type": "string",
"description": "OIDC subject claim for Workload Identity Federation. Identifies the workload service account."
},
"aws": {
"required": [
"audience",
"thumbprint"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "AWS STS audience for AssumeRoleWithWebIdentity."
},
"thumbprint": {
"type": "string",
"description": "AWS OIDC provider thumbprint for trust verification."
}
},
"description": "Amazon Web Services specific WIF configuration."
},
"issuer": {
"type": "string",
"description": "OIDC issuer URL for Workload Identity Federation."
},
"azure": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "Azure AD audience for workload identity federation."
}
},
"description": "Microsoft Azure specific WIF configuration."
}
},
"description": "Workload Identity Federation (WIF) configuration for this integration. Only present for built-in integrations. Provides OIDC issuer, subject, and cloud provider-specific configuration needed to set up trust relationships for workload identity."
},
"isBuiltIn": {
"type": "boolean",
"description": "Indicates whether this integration is a built-in system integration."
}
},
"description": "Status information for integrations. Always includes the isBuiltIn field in responses. Workload Identity Federation (WIF) information is only present for built-in integrations. This field is read-only and ignored in request bodies."
}
}
},
"meshLandingZone-Get-openshift": {
"title": "meshLandingZone-Get-openshift",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"tags"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier as 'name' to uniquely identify the meshLandingZone."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshLandingZone."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshLandingZone."
}
},
"description": "Always contains the 'name' to uniquely identify the meshLandingZone."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLandingZone datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLandingZone' for this endpoint."
},
"spec": {
"required": [
"automateDeletionApproval",
"automateDeletionReplication",
"displayName",
"mandatoryBuildingBlockRefs",
"platformRef",
"quotas",
"recommendedBuildingBlockRefs"
],
"type": "object",
"properties": {
"platformProperties": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more Kubernetes ClusterRoles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the Kubernetes Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of Kubernetes ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to Kubernetes ClusterRoles."
}
}
}
}
}
},
"azurerg": {
"required": [
"azureRgLocation",
"azureRgRoleMappings"
],
"type": "object",
"properties": {
"azureRgRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure Resource Group specific access role. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitionIds",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitionIds": {
"type": "array",
"description": "A list of Azure Role Definition IDs (e.g. 'fd876abe-603d-44d2-bf8a-067bbeacd485') that will be attached to users assigned to this role mapping within the Resource Group.",
"items": {
"type": "string"
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure Resource Group role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureRgLocation": {
"type": "string",
"description": "The newly created Resource Group for the meshProjects will get assigned to this location. It must be all lower case and without spaces (e.g. eastus2 for East US 2). In order to list the available locations you can use `az account list-locations --query \"[*].name\" --out tsv | sort`"
}
}
},
"gcp": {
"required": [
"gcpFolderId",
"gcpRoleMappings"
],
"type": "object",
"properties": {
"gcpFolderId": {
"type": "string",
"description": "Google Cloud Projects will be added to this Google Cloud Folder. This allows applying Organization Policies to all projects managed under this Landing Zone."
},
"gcpRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more GCP roles. You can use both built-in roles like 'roles/editor' or custom roles like 'organizations/123123123123/roles/meshstack.project_developer'. For more information see https://docs.meshcloud.io/meshstack.gcp.landing-zones/#meshrole-to-platform-role-mapping[the Landing Zone documentation]. Multiple GCP Roles can be assigned to one meshRole. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of GCP role identifiers assigned to users with the referenced meshProject role. Supports built-in roles (e.g. 'roles/editor') and custom roles (e.g. 'organizations/123/roles/my.role').",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to GCP roles."
}
}
}
},
"gcpTemplateUrl": {
"type": "string",
"description": "URL to a GCP bucket (starts with 'gs://') with a template config. The template is deployed in the project during the replication process. Only YAML files are supported with a file size limit of 1 MB.",
"nullable": true
},
"gcpCloudFunctionUrl": {
"type": "string",
"description": "If a GCP Cloud Function URL is provided it is getting called at the end of the replication process.",
"nullable": true
}
}
},
"custom": {
"type": "object",
"description": "Custom platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"openshift": {
"type": "object",
"description": "OpenShift platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"aks": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more AKS Cluster Roles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the AKS Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of AKS ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to AKS Cluster Roles."
}
}
}
}
}
},
"type": {
"type": "string",
"description": "The platform type. Possible values are: 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift'."
},
"aws": {
"required": [
"awsEnrollAccount",
"awsRoleMappings",
"awsTargetOrgUnitId"
],
"type": "object",
"properties": {
"awsTargetOrgUnitId": {
"type": "string",
"description": "The created AWS account for this Landing Zone will be put under the given Organizational Unit. You can also input a Root ID (starting with 'r-') then the account will be put directly under this root without assigning it to an OU (this is not recommended)."
},
"awsLambdaArn": {
"type": "string",
"description": "If this Lambda ARN is given, it is invoked after each project replication. You can use it to trigger a custom Account Vending Machine to perform several additional provisioning steps.",
"nullable": true
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS Role. The AWS role will be part of the role or group name within AWS. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRole",
"policies",
"projectRoleRef"
],
"type": "object",
"properties": {
"policies": {
"type": "array",
"description": "A list of AWS policy ARNs (e.g. 'arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess') that will be attached to the AWS IAM role. Leave empty if you use external roles that are managed outside meshStack.",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an AWS role."
},
"platformRole": {
"type": "string",
"description": "The AWS IAM role name that users with the referenced meshProject role will be assigned to. This role must exist in the AWS account."
}
}
}
},
"awsEnrollAccount": {
"type": "boolean",
"description": "If true, accounts will be enrolled to AWS control tower. In case an enrollment configuration is provided for the AWS platform AND this value is set to true, created AWS accounts will automatically be enrolled with AWS Control Tower. Automatic account enrollment does also require the Target Organizational Unit to already be enrolled with AWS Control Tower and the corresponding meshfed-service role needs to be in the \"IAM Principal\" list for the Portfolio access of the Account Factory Product ID you defined in platform settings. Click https://docs.meshcloud.io/integrations/aws/how-to-integrate/#8-integrate-aws-control-tower[here] to learn more about the Control Tower setup."
}
}
},
"azure": {
"required": [
"azureManagementGroupId",
"azureRoleMappings"
],
"type": "object",
"properties": {
"azureRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure specific access role. If empty, default role mappings defined on meshPlatform level are used. For more information see https://docs.meshcloud.io/meshstack.azure.landing-zones#meshrole-to-platform-role-mapping[the Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitions",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitions": {
"type": "array",
"description": "A list of Azure Role Definitions with the given IDs that will be attached to this Azure role mapping.",
"items": {
"required": [
"azureRoleDefinitionId"
],
"type": "object",
"properties": {
"abacCondition": {
"type": "string",
"description": "An optional ABAC (Attribute-Based Access Control) condition expression for the role assignment. When set, this condition restricts the scope of the role assignment.",
"nullable": true
},
"azureRoleDefinitionId": {
"type": "string",
"description": "The ID of the Azure Role Definition to attach (e.g. 'c5935d7e-37b2-4f34-af8f-bdca2408296e'). You can use `az role definition list` to find available role definition IDs."
}
}
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureManagementGroupId": {
"type": "string",
"description": "Subscriptions with this Landing Zone will be added to this Management Group. Please make sure to use the Management Group ID and not the group name!"
}
}
}
},
"description": "Custom properties for the platform of the landing zone. The values depend on the platform type. "
},
"quotas": {
"type": "array",
"description": "List of default quotas applied via this landing zone. Quotas define resource limits that will be applied to tenants using this landing zone. Tenants can afterwards request different quotas if needed. The available quota keys depend on the platform type and its quota definitions. For platforms that do not support quotas, this will be an empty array.",
"items": {
"required": [
"key",
"value"
],
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The quota value for this landing zone. Must be within the min/max range defined in the platform's quota definition."
},
"key": {
"type": "string",
"description": "The quota key as defined in the platform's quota definitions. Must match a quota definition key from the platform."
}
}
}
},
"automateDeletionApproval": {
"type": "boolean",
"description": "Whether deletion approval is automated for this landing zone."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshLandingZone."
},
"description": {
"type": "string",
"description": "The description of the meshLandingZone.",
"nullable": true
},
"automateDeletionReplication": {
"type": "boolean",
"description": "Whether deletion replication is automated for this landing zone."
},
"mandatoryBuildingBlockRefs": {
"type": "array",
"description": "List of mandatory building blocks that must be present when creating tenants with this landing zone. Building blocks are additional infrastructure components or configurations that enhance tenant capabilities. All mandatory building blocks will be automatically added to tenants created with this landing zone. Validation rule: If a mandatory building block has parent dependencies, all parent building blocks must also be included in the mandatory list.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition . Must refer to an existing building block definition. If a mandatory building block depends on other building blocks (parent dependencies), those parent building blocks must also be included in the mandatory list."
}
}
}
},
"recommendedBuildingBlockRefs": {
"type": "array",
"description": "List of recommended building blocks that are suggested when creating tenants with this landing zone. These building blocks are not mandatory and can be optionally selected by users during tenant creation. Validation rule: If a recommended building block has parent dependencies, all parent building blocks must be included in either the mandatory or recommended lists.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition. Must refer to an existing building block definition. If a recommended building block depends on other building blocks (parent dependencies), those parent building blocks must be included in either the mandatory or recommended lists."
}
}
}
},
"platformRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshPlatform\""
},
"uuid": {
"type": "string",
"description": "The UUID of the platform instance."
}
},
"description": "Reference to the platform instance this landing zone belongs to."
},
"infoLink": {
"type": "string",
"description": "An optional link to describe more details about the landing zone",
"nullable": true
}
},
"description": "All fields in this section describe the meshLandingZone."
},
"status": {
"required": [
"lifecycle",
"restricted"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the landing zone. Possible values: ACTIVE (landing zone is active and can be used), DEACTIVATED (landing zone has been deactivated and cannot be used anymore)."
}
},
"description": "Lifecycle information of the landing zone."
},
"restricted": {
"type": "boolean",
"description": "If true, users will be unable to select this landing zone in meshPanel. Only Platform teams can create tenants using restricted landing zones with the meshObject API."
}
},
"description": "Current status of the meshLandingZone."
}
}
},
"meshProjectRoleV1Post": {
"title": "meshProjectRoleV1Post",
"type": "object"
},
"api-meshobjects-meshplatforms-86531993": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef",
"quotaDefinitions"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"accessInformation": {
"type": "string",
"description": "Optional access information note in Markdown format shown to platform consumers.",
"nullable": true
},
"quotaDefinitions": {
"type": "array",
"description": "List of platform quota definitions. Quota definitions define the available quotas that can be configured for tenants on this platform. Currently only supported for platform types: OPENSHIFT, KUBERNETES, AZURE_KUBERNETES_SERVICE, CLOUDFOUNDRY, OPENSTACK. For unsupported platform types (those not listed above), quota definitions have to be provided as an empty array. For supported platform types, providing an empty array will remove all existing quota definitions of the given platform.",
"items": {
"required": [
"autoApprovalThreshold",
"description",
"label",
"maxValue",
"minValue",
"quotaKey"
],
"type": "object",
"properties": {
"quotaKey": {
"type": "string",
"description": "The key of the quota as it is required by the cloud platform."
},
"minValue": {
"type": "number",
"description": "Minimum allowed value for this quota."
},
"unit": {
"type": "string",
"description": "Unit of measurement for the quota (e.g., 'cores', 'GB', 'requests'). Must match the unit expected by the cloud platform.",
"nullable": true
},
"autoApprovalThreshold": {
"type": "number",
"description": "Threshold below which quota requests are automatically approved."
},
"maxValue": {
"type": "number",
"description": "Maximum allowed value for this quota."
},
"description": {
"type": "string",
"description": "Detailed description of what this quota controls."
},
"label": {
"type": "string",
"description": "Human-readable label for the quota."
}
}
}
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
},
"name": {
"type": "string",
"description": "The identifier of the location."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"publicationState",
"restriction"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"readme": {
"type": "string",
"description": "README about the meshPlatform in markdown format",
"nullable": true
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client config for metering"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for Kubernetes"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure Resource Group"
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"gcpRoleMappings",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"serviceAccount",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"gcpRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"gcpRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"gcpRole": {
"type": "string",
"description": "GCP role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP API access"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
},
"metering": {
"required": [
"bigqueryTable",
"partitionTimeColumn",
"processing",
"serviceAccount"
],
"type": "object",
"properties": {
"partitionTimeColumn": {
"type": "string",
"description": "Column name for partitioning time-based data"
},
"additionalFilter": {
"type": "string",
"description": "Additional SQL filter for billing data (optional)",
"nullable": true
},
"bigqueryTableForCarbonFootprint": {
"type": "string",
"description": "BigQuery table containing carbon footprint data (optional)",
"nullable": true
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"carbonFootprintDataCollectionStartMonth": {
"type": "string",
"description": "Start month for carbon footprint data collection (optional)",
"nullable": true
},
"bigqueryTable": {
"type": "string",
"description": "BigQuery table containing billing data export"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account for metering, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider for metering access."
}
},
"description": "Service account workload identity configuration for metering (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for metering service account. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP metering API access"
}
},
"description": "Metering configuration for GCP (optional, but required for metering)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"openshiftRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"openshiftRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"openshiftRole": {
"type": "string",
"description": "OpenShift role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identifier of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Access token for Kubernetes API authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Kubernetes client configuration for metering access"
}
},
"description": "Metering configuration for OpenShift (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"custom": {
"required": [
"platformTypeRef"
],
"type": "object",
"properties": {
"platformTypeRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this ref."
},
"name": {
"type": "string",
"description": "Identifier of the custom platform type"
}
},
"description": "Reference to the specific custom platform type to use"
},
"metering": {
"required": [
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for custom platforms"
}
},
"description": "Custom platforms don't have a replicator configuration and only support defining a platformType and basic metering."
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of AKS authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator EntraID access to manage groups that are used for RBAC in the AKS cluster."
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the Kubernetes service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"metering": {
"required": [
"clientConfig"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
}
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Replication configuration for AKS (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Configuration for Azure Kubernetes Service (AKS)"
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"accountNamePattern": {
"type": "string",
"description": "Defines the pattern for the AWS account name. If none provided, uses default of '#{workspaceIdentifier}.#{projectIdentifier}'.",
"nullable": true
},
"awsIdentityStore": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"identityStoreId",
"signInUrl"
],
"type": "object",
"properties": {
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign-in URL that end-users must use to log in to the AWS Management Console via AWS IAM Identity Center."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS IAM Identity Center permission set.",
"items": {
"required": [
"awsRole",
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"awsRole": {
"type": "string",
"description": "The name of the AWS role alias used as a suffix in the group name pattern."
},
"permissionSetArns": {
"type": "array",
"description": "The ARNs of the AWS IAM Identity Center permission sets to assign to the group. At least one permission set ARN is required.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
},
"identityStoreId": {
"type": "string",
"description": "The ID of the AWS IAM Identity Center Identity Store associated with this instance. E.g. d-1234567890. You can find this in the AWS IAM Identity Center console."
}
},
"description": "AWS IAM Identity Center integration using the AWS Identity Store API. This is an alternative to the SCIM-based awsSso integration that requires no long-lived SCIM bearer token and is fully compatible with Workload Identity Federation (WIF). Only one of awsSso or awsIdentityStore may be configured at a time. If neither is configured, IAM/group replication is disabled (IAM type 'None')."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later. "
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role. ",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys."
},
"awsSso": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The AWS IAM Identity Center SCIM Access Token. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS role.",
"items": {
"required": [
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration. Configure this to use the legacy SCIM-based IAM integration. Leave both awsSso and awsIdentityStore unset to disable IAM/group replication (IAM type 'None')."
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"metering": {
"required": [
"accessConfig",
"filter",
"processing",
"reservedInstanceFairChargeback",
"savingsPlanFairChargeback"
],
"type": "object",
"properties": {
"filter": {
"type": "string",
"description": "Cost Explorer filter type. NONE includes all costs, EXCLUDE_TAX filters out tax charges."
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role for metering access."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role for metering access via workload identity federation"
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for metering service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for metering service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS metering access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId for enhanced security when assuming the organization root account role for metering.",
"nullable": true
}
},
"description": "AWS access configuration for metering"
},
"savingsPlanFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for savings plans"
},
"reservedInstanceFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for reserved instances"
}
},
"description": "Metering configuration for AWS (optional, but required for metering)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "Configuration for AWS"
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"azureRoleMappings",
"groupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"updateSubscriptionName",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"azureRoleMappings": {
"type": "array",
"description": "Role mappings for Azure with project role references",
"items": {
"required": [
"azureRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRole": {
"required": [
"alias",
"id"
],
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "Alias for the Azure role"
},
"id": {
"type": "string",
"description": "ID of the Azure role"
}
},
"description": "Azure role"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"updateSubscriptionName": {
"type": "boolean",
"description": "Configures whether subscription names should be updated to match the subscription name pattern during replication."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"auth",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure Graph API authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the source service principal for replicator access to a customer agreement. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
},
"metering": {
"required": [
"processing",
"servicePrincipal"
],
"type": "object",
"properties": {
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Client ID of the service principal for metering"
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "Object ID of the service principal for metering"
}
},
"description": "Service principal configuration for metering access"
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for Azure (optional, but required for metering)"
}
},
"description": "Configuration for Azure"
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
}
}
},
"api-meshobjects-meshintegrations-uuid795364056": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the integration across all integrations.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace identifier that owns this integration."
}
},
"description": "Contains identifiers and ownership information for the integration."
},
"apiVersion": {
"type": "string",
"description": "Version of meshIntegration datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshIntegration' for this endpoint."
},
"spec": {
"required": [
"config",
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the integration."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"github": {
"required": [
"appId",
"appPrivateKey",
"baseUrl",
"owner",
"runnerRef"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The GitHub organization or user that owns the repositories."
},
"baseUrl": {
"type": "string",
"description": "The base URL of the GitHub API. Use 'https://api.github.com' for GitHub.com or your GitHub Enterprise URL."
},
"appPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The GitHub App private key for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"appId": {
"type": "string",
"description": "The GitHub App ID for authentication."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitHub-specific integration configuration."
},
"entraid": {
"required": [
"clientId",
"clientSecret",
"tenantId"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "The redirect URL to configure in the Entra Id app registration. This field is read-only and computed by the system.",
"nullable": true
},
"clientId": {
"type": "string",
"description": "The application (client) Id registered in the Entra Id tenant."
},
"tenantId": {
"type": "string",
"description": "The Microsoft Entra Id (Azure AD) tenant Id."
},
"clientSecret": {
"type": "object",
"description": "The client secret for authenticating with the Entra Id application. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Entra Id-specific integration configuration."
},
"azuredevops": {
"required": [
"baseUrl",
"organization",
"personalAccessToken",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the Azure DevOps instance. Typically 'https://dev.azure.com' for Azure DevOps Services."
},
"organization": {
"type": "string",
"description": "The Azure DevOps organization name."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
},
"personalAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Personal Access Token (PAT) for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Azure DevOps-specific integration configuration."
},
"gitlab": {
"required": [
"baseUrl",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the GitLab instance. Use 'https://gitlab.com' for GitLab.com or your self-hosted GitLab URL."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitLab-specific integration configuration."
},
"type": {
"type": "string",
"description": "The type of integration. Available types are: 'azuredevops','entraid','github','gitlab','metering','replicator'. EntraId integrations are only available for the admin workspace."
}
},
"description": "Integration configuration. Contains a 'type' field that determines the integration type ('azuredevops','entraid','github','gitlab','metering','replicator') and type-specific properties nested under the corresponding key (e.g., 'github', 'gitlab', 'azuredevops')."
}
},
"description": "All fields in this section describe the integration configuration."
}
}
},
"meshProjectGroupBindingListV3": {
"title": "meshProjectGroupBindingListV3",
"required": [
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshProjectGroupBindings"
],
"type": "object",
"properties": {
"meshProjectGroupBindings": {
"type": "array",
"description": "List of meshProjectGroupBindings.",
"items": {
"type": "object",
"properties": {
"targetRef": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the project the group is assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of this user group."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this group."
}
}
}
}
}
}
}
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshBuildingBlock": {
"title": "meshBuildingBlock",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"createdOn",
"definitionUuid",
"definitionVersion",
"forcePurge",
"tenantIdentifier",
"uuid"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the date when a user requested the deletion is provided via this field. e.g. `2020-12-22T09:37:43Z`",
"nullable": true
},
"forcePurge": {
"type": "boolean",
"description": "Set to true, if an operator explicitly requested this Building Block to be purged."
},
"definitionVersion": {
"type": "number",
"description": "The version number of the Building Block Definition this Building Block is based on."
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block has already been deleted, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The Building Block has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
},
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition this Building Block is based on."
},
"tenantIdentifier": {
"type": "string",
"description": "The full identifier of the tenant, this Building Block is created in."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block. It also contains additional meta information like the Building Block creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"displayName",
"inputs",
"parentBuildingBlocks"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent building blocks, which are set on the Building Block.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"inputs": {
"type": "array",
"description": "List of inputs, which are set on the Building Block.",
"items": {
"required": [
"key",
"value",
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value, which is set on this input."
},
"key": {
"type": "string",
"description": "The key of the input as set on the related Building Block Definition."
}
}
}
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
}
},
"description": "All fields in this section describe the Building Block."
},
"status": {
"required": [
"outputs",
"status"
],
"type": "object",
"properties": {
"outputs": {
"type": "array",
"description": "List of outputs, which are set on the Building Block.",
"items": {
"required": [
"key",
"value",
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value, which is set on this output."
},
"key": {
"type": "string",
"description": "The key of the output as set on the related Building Block Definition."
}
}
}
},
"status": {
"type": "string",
"description": "The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
},
"description": "All fields in this section describe the current status of the Building Block."
}
}
},
"meshTenantListV3": {
"title": "meshTenantListV3",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshTenants"
],
"type": "object",
"properties": {
"meshTenants": {
"type": "array",
"description": "List of meshTenant.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshIntegration-List": {
"title": "meshIntegration-List",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshIntegrations"
],
"type": "object",
"properties": {
"meshIntegrations": {
"type": "array",
"description": "List of meshIntegrations.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the integration across all integrations.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace identifier that owns this integration."
}
},
"description": "Contains identifiers and ownership information for the integration."
},
"apiVersion": {
"type": "string",
"description": "Version of meshIntegration datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshIntegration."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshIntegration' for this endpoint."
},
"spec": {
"required": [
"config",
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the integration."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"github": {
"required": [
"appId",
"appPrivateKey",
"baseUrl",
"owner",
"runnerRef"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The GitHub organization or user that owns the repositories."
},
"baseUrl": {
"type": "string",
"description": "The base URL of the GitHub API. Use 'https://api.github.com' for GitHub.com or your GitHub Enterprise URL."
},
"appPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The GitHub App private key for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"appId": {
"type": "string",
"description": "The GitHub App ID for authentication."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitHub-specific integration configuration."
},
"azuredevops": {
"required": [
"baseUrl",
"organization",
"personalAccessToken",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the Azure DevOps instance. Typically 'https://dev.azure.com' for Azure DevOps Services."
},
"organization": {
"type": "string",
"description": "The Azure DevOps organization name."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
},
"personalAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Personal Access Token (PAT) for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Azure DevOps-specific integration configuration."
},
"gitlab": {
"required": [
"baseUrl",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the GitLab instance. Use 'https://gitlab.com' for GitLab.com or your self-hosted GitLab URL."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitLab-specific integration configuration."
},
"type": {
"type": "string",
"description": "The type of integration. Available types are: 'azuredevops','entraid','github','gitlab','metering','replicator'. EntraId integrations are only available for the admin workspace."
}
},
"description": "Integration configuration. Contains a 'type' field that determines the integration type ('azuredevops','entraid','github','gitlab','metering','replicator') and type-specific properties nested under the corresponding key (e.g., 'github', 'gitlab', 'azuredevops')."
}
},
"description": "All fields in this section describe the integration configuration."
},
"status": {
"required": [
"isBuiltIn",
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the integration. For meshIntegration, only ACTIVE is supported."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the integration was created. This field is automatically set by the system and cannot be modified.",
"nullable": true
}
},
"description": "Lifecycle information of the integration."
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "GCP Workload Identity Pool audience for token exchange."
}
},
"description": "Google Cloud Platform specific WIF configuration."
},
"subject": {
"type": "string",
"description": "OIDC subject claim for Workload Identity Federation. Identifies the workload service account."
},
"aws": {
"required": [
"audience",
"thumbprint"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "AWS STS audience for AssumeRoleWithWebIdentity."
},
"thumbprint": {
"type": "string",
"description": "AWS OIDC provider thumbprint for trust verification."
}
},
"description": "Amazon Web Services specific WIF configuration."
},
"issuer": {
"type": "string",
"description": "OIDC issuer URL for Workload Identity Federation."
},
"azure": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "Azure AD audience for workload identity federation."
}
},
"description": "Microsoft Azure specific WIF configuration."
}
},
"description": "Workload Identity Federation (WIF) configuration for this integration. Only present for built-in integrations. Provides OIDC issuer, subject, and cloud provider-specific configuration needed to set up trust relationships for workload identity."
},
"isBuiltIn": {
"type": "boolean",
"description": "Indicates whether this integration is a built-in system integration."
}
},
"description": "Status information for integrations. Always includes the isBuiltIn field in responses. Workload Identity Federation (WIF) information is only present for built-in integrations. This field is read-only and ignored in request bodies."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshcommunicationdefinitions-uuid1963883446": {
"required": [
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"description": "API version of the resource."
},
"kind": {
"type": "string",
"description": "Kind of mesh object, always 'MeshCommunicationDefinition'."
},
"spec": {
"type": "object",
"properties": {
"communication": {
"required": [
"dueDate",
"message",
"title",
"type"
],
"type": "object",
"properties": {
"skipEmailNotifications": {
"type": "boolean",
"description": "Whether to skip sending email notifications for this communication. Defaults to false.",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "The due date in ISO 8601 format."
},
"type": {
"type": "string",
"description": "The type of communication: ACTION_REQUIRED or NOTIFICATION."
},
"message": {
"type": "string",
"description": "The message content of the communication."
},
"title": {
"type": "string",
"description": "The title of the communication definition."
}
}
}
}
}
}
},
"meshCommunicationDefinitionPost": {
"title": "meshCommunicationDefinitionPost",
"type": "object",
"properties": {
"status": {
"required": [
"communicationsOpen",
"communicationsResolved",
"communicationsTotal"
],
"type": "object",
"properties": {
"communicationsOpen": {
"type": "number",
"description": "the amount of open (unresolved) communications. This field is only present for communication definitions of type ACTION_REQUIRED, because other types of communications are not meant to be resolved."
},
"communicationsResolved": {
"type": "number",
"description": "the amount of resolved communications. This field is only present for communication definitions of type ACTION_REQUIRED, because other types of communications are not meant to be resolved."
},
"communicationsTotal": {
"type": "number",
"description": "the total amount of communications associated to this definition."
}
}
}
}
},
"api-meshobjects-meshbuildingblockrunners-buildingBlockRunnerUuid816872201": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies this meshBuildingBlockRunner. Must not be provided on creation \u2014 meshStack assigns a UUID automatically. On update (PUT), this field is mandatory and must match the UUID in the path parameter.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshBuildingBlockRunner."
}
},
"description": "Contains identifying properties of the meshBuildingBlockRunner."
},
"apiVersion": {
"type": "string",
"description": "Version of meshBuildingBlockRunner datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockRunner' for this endpoint."
},
"spec": {
"required": [
"displayName",
"implementationType",
"publicKey"
],
"type": "object",
"properties": {
"implementationType": {
"type": "string",
"description": "The type of building block implementation this runner handles. Possible values: `TERRAFORM`, `GITHUB_WORKFLOW`, `GITLAB_PIPELINE`, `AZURE_DEVOPS_PIPELINE`, `MANUAL`."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of this meshBuildingBlockRunner."
},
"restriction": {
"type": "string",
"description": "Visibility restriction of this runner. `PUBLIC` makes the runner available to all workspaces in meshStack. `PRIVATE` (default) restricts it to the owning workspace. Only administrators can create or update runners with `PUBLIC` restriction.",
"nullable": true
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the GCP federated token, e.g. `/var/run/secrets/workload-identity/gcp/token`."
},
"audience": {
"type": "string",
"description": "The audience for the GCP Workload Identity Federation token, e.g. `//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/my-provider`."
}
},
"description": "GCP-specific Workload Identity Federation configuration for this runner."
},
"subject": {
"type": "string",
"description": "The subject claim of the OIDC token issued to this runner, e.g. `system:serviceaccount:meshfed:my-runner`."
},
"aws": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the AWS federated token, e.g. `/var/run/secrets/workload-identity/aws/token`."
},
"audience": {
"type": "string",
"description": "The audience for the AWS STS AssumeRoleWithWebIdentity call, typically `sts.amazonaws.com`."
},
"thumbprint": {
"type": "string",
"description": "Optional thumbprint of the OIDC provider's root CA certificate for AWS.",
"nullable": true
}
},
"description": "AWS-specific Workload Identity Federation configuration for this runner."
},
"issuer": {
"type": "string",
"description": "The OIDC issuer URL of the identity provider that issues tokens for this runner. This is used to configure trust with the target cloud provider."
},
"azure": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the Azure federated token, e.g. `/var/run/secrets/workload-identity/azure/token`."
},
"audience": {
"type": "string",
"description": "The audience for the Azure federated identity token exchange, typically `api://AzureADTokenExchange`."
}
},
"description": "Azure-specific Workload Identity Federation configuration for this runner."
}
},
"description": "Optional Workload Identity Federation (WIF) configuration for this runner. When configured, the runner can authenticate to cloud providers using short-lived tokens instead of long-lived credentials. At least one of `gcp`, `aws`, or `azure` must be provided."
},
"publicKey": {
"type": "string",
"description": "The RSA public key (PEM-encoded) used to encrypt secrets that are sent to this runner. Accepts either a PEM-encoded public key (BEGIN PUBLIC KEY) or an X.509 certificate (BEGIN CERTIFICATE). The runner uses the corresponding private key to decrypt those secrets at runtime."
}
},
"description": "All fields in this section describe the configuration of the meshBuildingBlockRunner."
}
}
},
"api-meshobjects-meshlandingzones-879138272": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"tags"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier as 'name' to uniquely identify the meshLandingZone."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshLandingZone."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshLandingZone."
}
},
"description": "Always contains the 'name' to uniquely identify the meshLandingZone."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLandingZone datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLandingZone' for this endpoint."
},
"spec": {
"required": [
"automateDeletionApproval",
"automateDeletionReplication",
"displayName",
"mandatoryBuildingBlockRefs",
"platformRef",
"quotas",
"recommendedBuildingBlockRefs"
],
"type": "object",
"properties": {
"platformProperties": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more Kubernetes ClusterRoles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the Kubernetes Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of Kubernetes ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to Kubernetes ClusterRoles."
}
}
}
}
}
},
"azurerg": {
"required": [
"azureRgLocation",
"azureRgRoleMappings"
],
"type": "object",
"properties": {
"azureRgRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure Resource Group specific access role. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitionIds",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitionIds": {
"type": "array",
"description": "A list of Azure Role Definition IDs (e.g. 'fd876abe-603d-44d2-bf8a-067bbeacd485') that will be attached to users assigned to this role mapping within the Resource Group.",
"items": {
"type": "string"
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure Resource Group role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureRgLocation": {
"type": "string",
"description": "The newly created Resource Group for the meshProjects will get assigned to this location. It must be all lower case and without spaces (e.g. eastus2 for East US 2). In order to list the available locations you can use `az account list-locations --query \"[*].name\" --out tsv | sort`"
}
}
},
"gcp": {
"required": [
"gcpFolderId",
"gcpRoleMappings"
],
"type": "object",
"properties": {
"gcpFolderId": {
"type": "string",
"description": "Google Cloud Projects will be added to this Google Cloud Folder. This allows applying Organization Policies to all projects managed under this Landing Zone."
},
"gcpRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more GCP roles. You can use both built-in roles like 'roles/editor' or custom roles like 'organizations/123123123123/roles/meshstack.project_developer'. For more information see https://docs.meshcloud.io/meshstack.gcp.landing-zones/#meshrole-to-platform-role-mapping[the Landing Zone documentation]. Multiple GCP Roles can be assigned to one meshRole. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of GCP role identifiers assigned to users with the referenced meshProject role. Supports built-in roles (e.g. 'roles/editor') and custom roles (e.g. 'organizations/123/roles/my.role').",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to GCP roles."
}
}
}
},
"gcpTemplateUrl": {
"type": "string",
"description": "URL to a GCP bucket (starts with 'gs://') with a template config. The template is deployed in the project during the replication process. Only YAML files are supported with a file size limit of 1 MB.",
"nullable": true
},
"gcpCloudFunctionUrl": {
"type": "string",
"description": "If a GCP Cloud Function URL is provided it is getting called at the end of the replication process.",
"nullable": true
}
}
},
"custom": {
"type": "object",
"description": "Custom platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"openshift": {
"type": "object",
"description": "OpenShift platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"aks": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more AKS Cluster Roles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the AKS Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of AKS ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to AKS Cluster Roles."
}
}
}
}
}
},
"type": {
"type": "string",
"description": "The platform type. Possible values are: 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift'."
},
"aws": {
"required": [
"awsEnrollAccount",
"awsRoleMappings",
"awsTargetOrgUnitId"
],
"type": "object",
"properties": {
"awsTargetOrgUnitId": {
"type": "string",
"description": "The created AWS account for this Landing Zone will be put under the given Organizational Unit. You can also input a Root ID (starting with 'r-') then the account will be put directly under this root without assigning it to an OU (this is not recommended)."
},
"awsLambdaArn": {
"type": "string",
"description": "If this Lambda ARN is given, it is invoked after each project replication. You can use it to trigger a custom Account Vending Machine to perform several additional provisioning steps.",
"nullable": true
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS Role. The AWS role will be part of the role or group name within AWS. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRole",
"policies",
"projectRoleRef"
],
"type": "object",
"properties": {
"policies": {
"type": "array",
"description": "A list of AWS policy ARNs (e.g. 'arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess') that will be attached to the AWS IAM role. Leave empty if you use external roles that are managed outside meshStack.",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an AWS role."
},
"platformRole": {
"type": "string",
"description": "The AWS IAM role name that users with the referenced meshProject role will be assigned to. This role must exist in the AWS account."
}
}
}
},
"awsEnrollAccount": {
"type": "boolean",
"description": "If true, accounts will be enrolled to AWS control tower. In case an enrollment configuration is provided for the AWS platform AND this value is set to true, created AWS accounts will automatically be enrolled with AWS Control Tower. Automatic account enrollment does also require the Target Organizational Unit to already be enrolled with AWS Control Tower and the corresponding meshfed-service role needs to be in the \"IAM Principal\" list for the Portfolio access of the Account Factory Product ID you defined in platform settings. Click https://docs.meshcloud.io/integrations/aws/how-to-integrate/#8-integrate-aws-control-tower[here] to learn more about the Control Tower setup."
}
}
},
"azure": {
"required": [
"azureManagementGroupId",
"azureRoleMappings"
],
"type": "object",
"properties": {
"azureRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure specific access role. If empty, default role mappings defined on meshPlatform level are used. For more information see https://docs.meshcloud.io/meshstack.azure.landing-zones#meshrole-to-platform-role-mapping[the Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitions",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitions": {
"type": "array",
"description": "A list of Azure Role Definitions with the given IDs that will be attached to this Azure role mapping.",
"items": {
"required": [
"azureRoleDefinitionId"
],
"type": "object",
"properties": {
"abacCondition": {
"type": "string",
"description": "An optional ABAC (Attribute-Based Access Control) condition expression for the role assignment. When set, this condition restricts the scope of the role assignment.",
"nullable": true
},
"azureRoleDefinitionId": {
"type": "string",
"description": "The ID of the Azure Role Definition to attach (e.g. 'c5935d7e-37b2-4f34-af8f-bdca2408296e'). You can use `az role definition list` to find available role definition IDs."
}
}
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureManagementGroupId": {
"type": "string",
"description": "Subscriptions with this Landing Zone will be added to this Management Group. Please make sure to use the Management Group ID and not the group name!"
}
}
}
},
"description": "Custom properties for the platform of the landing zone. The values depend on the platform type. "
},
"quotas": {
"type": "array",
"description": "List of default quotas applied via this landing zone. Quotas define resource limits that will be applied to tenants using this landing zone. Tenants can afterwards request different quotas if needed. The available quota keys depend on the platform type and its quota definitions. For platforms that do not support quotas, this will be an empty array.",
"items": {
"required": [
"key",
"value"
],
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The quota value for this landing zone. Must be within the min/max range defined in the platform's quota definition."
},
"key": {
"type": "string",
"description": "The quota key as defined in the platform's quota definitions. Must match a quota definition key from the platform."
}
}
}
},
"automateDeletionApproval": {
"type": "boolean",
"description": "Whether deletion approval is automated for this landing zone."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshLandingZone."
},
"description": {
"type": "string",
"description": "The description of the meshLandingZone.",
"nullable": true
},
"automateDeletionReplication": {
"type": "boolean",
"description": "Whether deletion replication is automated for this landing zone."
},
"mandatoryBuildingBlockRefs": {
"type": "array",
"description": "List of mandatory building blocks that must be present when creating tenants with this landing zone. Building blocks are additional infrastructure components or configurations that enhance tenant capabilities. All mandatory building blocks will be automatically added to tenants created with this landing zone. Validation rule: If a mandatory building block has parent dependencies, all parent building blocks must also be included in the mandatory list.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition . Must refer to an existing building block definition. If a mandatory building block depends on other building blocks (parent dependencies), those parent building blocks must also be included in the mandatory list."
}
}
}
},
"recommendedBuildingBlockRefs": {
"type": "array",
"description": "List of recommended building blocks that are suggested when creating tenants with this landing zone. These building blocks are not mandatory and can be optionally selected by users during tenant creation. Validation rule: If a recommended building block has parent dependencies, all parent building blocks must be included in either the mandatory or recommended lists.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition. Must refer to an existing building block definition. If a recommended building block depends on other building blocks (parent dependencies), those parent building blocks must be included in either the mandatory or recommended lists."
}
}
}
},
"platformRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshPlatform\""
},
"uuid": {
"type": "string",
"description": "The UUID of the platform instance."
}
},
"description": "Reference to the platform instance this landing zone belongs to."
},
"infoLink": {
"type": "string",
"description": "An optional link to describe more details about the landing zone",
"nullable": true
}
},
"description": "All fields in this section describe the meshLandingZone."
}
}
},
"meshProjectGroupBindingV3": {
"title": "meshProjectGroupBindingV3",
"required": [
"_links",
"apiVersion",
"kind",
"metadata"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the project the group is assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the project the group is assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The meshProjectGroupBinding identifier as 'name' to uniquely identify the meshProjectGroupBinding."
}
},
"description": "Always contains the 'name' to uniquely identify the meshProjectGroupBinding."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProjectGroupBinding datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of this user group."
}
}
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectGroupBinding' for this endpoint."
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this group."
}
}
}
}
},
"meshApiKey-Put": {
"title": "meshApiKey-Put",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"description": "Timestamp when the API key was created (ISO-8601 instant format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "UUID of the API key.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "Identifier of the workspace that owns this API key."
}
},
"description": "Metadata that identifies and scopes the meshApiKey."
},
"apiVersion": {
"type": "string",
"description": "Version of meshApiKey datatype. For this endpoint this is always 'v1-preview'."
},
"_links": {
"type": "object",
"description": "Available links on a meshApiKey."
},
"kind": {
"type": "string",
"description": "The meshObject kind. For this endpoint this is always 'meshApiKey'."
},
"spec": {
"required": [
"displayName",
"permissions"
],
"type": "object",
"properties": {
"permissions": {
"type": "array",
"description": "Set of permission short-codes assigned to this API key.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"displayName": {
"type": "string",
"description": "Display name of the API key."
},
"expiresAt": {
"type": "string",
"description": "Expiration date of the API key (ISO-8601 date format, e.g. 2025-12-31). Nullable if the key does not expire.",
"nullable": true
}
},
"description": "Configuration of the meshApiKey."
},
"status": {
"required": [
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The clientId used for authentication. Same as metadata.uuid."
},
"clientSecret": {
"type": "string",
"description": "The clientSecret used for authentication. Only included on creation (POST) or when the secret is rotated due to an expiresAt change (PUT). Omitted on GET.",
"nullable": true
}
},
"description": "Status information including clientId and the clientSecret (only on creation or key rotation)."
}
}
},
"meshPaymentMethodV2": {
"title": "meshPaymentMethodV2",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The paymentMethodIdentifier as 'name'."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspaceIdentifier as 'ownedByWorkspace'."
}
},
"description": "Always contains the 'name' and (optional) 'ownedByWorkspace' to uniquely identify the meshPaymentMethod."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPaymentMethod datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshPaymentMethod."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPaymentMethod' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "The amount of the meshPaymentMethod.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshPaymentMethod as it is shown in meshPanel."
},
"expirationDate": {
"type": "string",
"description": "The expiration date (yyyy-MM-dd) of the meshPaymentMethod. The date is considered as UTC.",
"nullable": true
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshPaymentMethod. Keep in mind, that values are an array.",
"nullable": true
}
},
"description": "All fields in this section describe the meshPaymentMethod."
}
}
},
"meshTagDefinitionPost": {
"title": "meshTagDefinitionPost",
"type": "object"
},
"meshProjectUserBindingListV3": {
"title": "meshProjectUserBindingListV3",
"required": [
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshProjectUserBindings"
],
"type": "object",
"properties": {
"meshProjectUserBindings": {
"type": "array",
"description": "List of meshProjectUserBindings.",
"items": {
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the project the user is assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the project the user is assigned to."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace which contains the project."
}
}
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username of the referenced user."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this user."
}
}
}
}
}
}
}
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshCommunicationList": {
"title": "meshCommunicationList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshCommunications"
],
"type": "object",
"properties": {
"meshCommunications": {
"type": "array",
"description": "List of meshCommunications.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshWorkspaceList": {
"title": "meshWorkspaceList",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshWorkspaces"
],
"type": "object",
"properties": {
"meshWorkspaces": {
"type": "array",
"description": "List of meshWorkspaces.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-metadata-openstackProjectMetadata-1305671199": {
"required": [
"project-id"
],
"type": "object",
"properties": {
"project-id": {
"type": "string",
"description": "The ID of the project metadata information shall be retrieved for."
}
}
},
"openStackProjectMetadata": {
"title": "openStackProjectMetadata",
"required": [
"customer-display-name",
"customer-identifier",
"project-display-name",
"project-identifier",
"tags"
],
"type": "object",
"properties": {
"customer-display-name": {
"type": "string",
"description": "Human readable customer name."
},
"project-identifier": {
"type": "string",
"description": "Immutable unique identifier of the project."
},
"customer-identifier": {
"type": "string",
"description": "Immutable unique identifier of the customer"
},
"project-display-name": {
"type": "string",
"description": "Human readable project name."
},
"tags": {
"required": [
"costCenter",
"customNumber"
],
"type": "object",
"properties": {
"costCenter": {
"type": "array",
"description": "A cost center number could be a custom tag.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"customNumber": {
"type": "array",
"description": "And any further attribute can be provided as a tag.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"description": "Custom tags specified on the project."
}
}
},
"api-meshobjects-meshcommunicationdefinitions-1419667539": {
"required": [
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"apiVersion": {
"type": "string",
"description": "API version of the resource."
},
"kind": {
"type": "string",
"description": "Kind of mesh object, always 'meshCommunicationDefinition'."
},
"spec": {
"type": "object",
"properties": {
"communication": {
"required": [
"dueDate",
"message",
"title",
"type"
],
"type": "object",
"properties": {
"skipEmailNotifications": {
"type": "boolean",
"description": "Whether to skip sending email notifications for this communication. Defaults to false.",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Due date in ISO 8601 format."
},
"type": {
"type": "string",
"description": "Type of communication: ACTION_REQUIRED or NOTIFICATION."
},
"message": {
"type": "string",
"description": "Content of the message."
},
"title": {
"type": "string",
"description": "Title of the communication."
}
}
}
}
}
}
},
"meshServiceInstanceListV2": {
"title": "meshServiceInstanceListV2",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshServiceInstances"
],
"type": "object",
"properties": {
"meshServiceInstances": {
"type": "array",
"description": "List of meshServiceInstances.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"instanceId",
"marketplaceIdentifier",
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The project that this Service Instance belongs to."
},
"marketplaceIdentifier": {
"type": "string",
"description": "The identifier of the marketplace that this Service Instance belongs to."
},
"instanceId": {
"type": "string",
"description": "The instance id of this Service Instance."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that this Service Instance belongs to."
}
},
"description": "Metadata and more fields to identify the Service Instance."
},
"apiVersion": {
"type": "string",
"description": "Version of meshServiceInstance datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "HATEOAS links for the Service Instance."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshServiceInstance' for this endpoint."
},
"spec": {
"required": [
"creator",
"displayName",
"planId",
"serviceId"
],
"type": "object",
"properties": {
"creator": {
"type": "string",
"description": "The meshUser `username` recorded as the creator of this Service Instance."
},
"displayName": {
"type": "string",
"description": "The display name of the Service Instance."
},
"planId": {
"type": "string",
"description": "The id of the plan for this Service Instance."
},
"serviceId": {
"type": "string",
"description": "The id of the service for the Service Instance."
},
"parameters": {
"type": "object",
"description": "Parameters that were passed to the Service Broker when provisioning or updating the service instance. The structure and content of this field is defined by the service broker.",
"nullable": true
},
"serviceBrokerIdentifier": {
"type": "string",
"description": "The identifier of the Service Broker managing this Service Instance.",
"nullable": true
}
},
"description": "All fields in this section describe the meshServiceInstance"
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshLocation-Get": {
"title": "meshLocation-Get",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshLocation."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshLocation. This is a common attribute for all meshObjects, but in case of a meshLocation it is not used for referencing the location. Instead the name (identifier) is used.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this location."
}
},
"description": "Contains the identifiers for the meshLocation."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLocation datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshLocation."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLocation' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshLocation shown in the UI."
},
"description": {
"type": "string",
"description": "An optional description of the meshLocation.",
"nullable": true
}
},
"description": "All fields in this section describe the meshLocation configuration."
},
"status": {
"required": [
"isPublic"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the meshLocation was deleted. Null if the location has not been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the meshLocation. Possible values are: ACTIVE, DEACTIVATED, DELETED."
},
"createdOn": {
"type": "string",
"description": "The timestamp when the meshLocation was created."
}
},
"description": "The lifecycle status of the meshLocation."
},
"isPublic": {
"type": "boolean",
"description": "Indicates whether the location has any public platform instances associated with it."
}
},
"description": "The current status of the meshLocation."
}
}
},
"meshCommunicationDefinition": {
"title": "meshCommunicationDefinition",
"required": [
"_links",
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier."
}
}
},
"apiVersion": {
"type": "string",
"description": "API version."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"kind": {
"type": "string",
"description": "Resource kind, always 'meshCommunicationDefinition'."
},
"spec": {
"type": "object",
"properties": {
"communication": {
"required": [
"dueDate",
"message",
"title",
"type"
],
"type": "object",
"properties": {
"skipEmailNotifications": {
"type": "boolean",
"description": "Whether to skip sending email notifications for this communication. Defaults to false.",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Due date (ISO format)."
},
"type": {
"type": "string",
"description": "Type of communication (e.g. ACTION_REQUIRED)."
},
"message": {
"type": "string",
"description": "Message content."
},
"title": {
"type": "string",
"description": "Title of the communication."
}
}
}
}
},
"status": {
"required": [
"communicationsOpen",
"communicationsResolved",
"communicationsTotal"
],
"type": "object",
"properties": {
"communicationsOpen": {
"type": "number",
"description": "the amount of open (unresolved) communications. This field is only present for communication definitions of type ACTION_REQUIRED, because other types of communications are not meant to be resolved."
},
"communicationsResolved": {
"type": "number",
"description": "the amount of resolved communications. This field is only present for communication definitions of type ACTION_REQUIRED, because other types of communications are not meant to be resolved."
},
"communicationsTotal": {
"type": "number",
"description": "the total amount of communications associated to this definition."
}
}
}
}
},
"meshWorkspaceGroupBinding": {
"title": "meshWorkspaceGroupBinding",
"required": [
"_links",
"apiVersion",
"kind",
"metadata"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"displayName",
"name"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The name of the workspace the group is assigned to."
},
"name": {
"type": "string",
"description": "The identifier of the workspace the group is assigned to."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The meshWorkspaceGroupBinding identifier as 'name' to uniquely identify the meshWorkspaceGroupBinding."
}
},
"description": "Always contains the 'name' to uniquely identify the meshWorkspaceGroupBinding."
},
"apiVersion": {
"type": "string",
"description": "Version of meshWorkspaceGroupBinding datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of this workspace user group."
}
}
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshWorkspaceGroupBinding' for this endpoint."
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this group."
}
}
}
}
},
"meshProjectV2": {
"title": "meshProjectV2",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "If the meshProject has been submitted for deletion by a Workspace Manager, the date, the date is represented here (e.g. `2020-12-22T09:37:43Z)`. Otherwise this field is missing.",
"nullable": true
},
"name": {
"type": "string",
"description": "The projectIdentifier as 'name'."
},
"createdOn": {
"type": "string",
"description": "The meshProject has been created at this date (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspaceIdentifier as 'ownedByWorkspace'."
}
},
"description": "Always contains the 'name' and 'ownedByWorkspace' to uniquely identify the meshProject."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProject datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshProject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProject' for this endpoint."
},
"spec": {
"required": [
"displayName",
"tags"
],
"type": "object",
"properties": {
"substitutePaymentMethodIdentifier": {
"type": "string",
"description": "The substitutePaymentMethod of the meshProject",
"nullable": true
},
"paymentMethodIdentifier": {
"type": "string",
"description": "The meshPaymentMethod of the meshProject.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshProject as it is shown in meshPanel."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshProject. Keep in mind, that values are an array."
}
},
"description": "All fields in this section describe the meshProject."
}
}
},
"api-meshobjects-meshprojectroles486549215": {
"type": "object"
},
"meshBuildingBlockRunner-Get": {
"title": "meshBuildingBlockRunner-Get",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"lastSeen": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner last connected to meshStack (ISO 8601 format). This is updated automatically whenever the runner polls for work.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner was created (ISO 8601 format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies this meshBuildingBlockRunner. Must not be provided on creation \u2014 meshStack assigns a UUID automatically. On update (PUT), this field is mandatory and must match the UUID in the path parameter.",
"nullable": true
},
"lastKnownVersion": {
"type": "string",
"description": "The last runner version reported via the X-Meshcloud-Runner-Version request header when polling for work. Null if the runner has never sent a version header.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshBuildingBlockRunner."
}
},
"description": "Contains identifying properties of the meshBuildingBlockRunner."
},
"apiVersion": {
"type": "string",
"description": "Version of meshBuildingBlockRunner datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockRunner' for this endpoint."
},
"spec": {
"required": [
"displayName",
"implementationType",
"publicKey"
],
"type": "object",
"properties": {
"implementationType": {
"type": "string",
"description": "The type of building block implementation this runner handles. Possible values: `TERRAFORM`, `GITHUB_WORKFLOW`, `GITLAB_PIPELINE`, `AZURE_DEVOPS_PIPELINE`, `MANUAL`."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of this meshBuildingBlockRunner."
},
"restriction": {
"type": "string",
"description": "Visibility restriction of this runner. `PUBLIC` makes the runner available to all workspaces in meshStack. `PRIVATE` (default) restricts it to the owning workspace. Only administrators can create or update runners with `PUBLIC` restriction.",
"nullable": true
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the GCP federated token, e.g. `/var/run/secrets/workload-identity/gcp/token`."
},
"audience": {
"type": "string",
"description": "The audience for the GCP Workload Identity Federation token, e.g. `//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/my-provider`."
}
},
"description": "GCP-specific Workload Identity Federation configuration for this runner."
},
"subject": {
"type": "string",
"description": "The subject claim of the OIDC token issued to this runner, e.g. `system:serviceaccount:meshfed:my-runner`."
},
"aws": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the AWS federated token, e.g. `/var/run/secrets/workload-identity/aws/token`."
},
"audience": {
"type": "string",
"description": "The audience for the AWS STS AssumeRoleWithWebIdentity call, typically `sts.amazonaws.com`."
},
"thumbprint": {
"type": "string",
"description": "Optional thumbprint of the OIDC provider's root CA certificate for AWS.",
"nullable": true
}
},
"description": "AWS-specific Workload Identity Federation configuration for this runner."
},
"issuer": {
"type": "string",
"description": "The OIDC issuer URL of the identity provider that issues tokens for this runner. This is used to configure trust with the target cloud provider."
},
"azure": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the Azure federated token, e.g. `/var/run/secrets/workload-identity/azure/token`."
},
"audience": {
"type": "string",
"description": "The audience for the Azure federated identity token exchange, typically `api://AzureADTokenExchange`."
}
},
"description": "Azure-specific Workload Identity Federation configuration for this runner."
}
},
"description": "Optional Workload Identity Federation (WIF) configuration for this runner. When configured, the runner can authenticate to cloud providers using short-lived tokens instead of long-lived credentials. At least one of `gcp`, `aws`, or `azure` must be provided."
},
"publicKey": {
"type": "string",
"description": "The RSA public key (PEM-encoded) used to encrypt secrets that are sent to this runner. Accepts either a PEM-encoded public key (BEGIN PUBLIC KEY) or an X.509 certificate (BEGIN CERTIFICATE). The runner uses the corresponding private key to decrypt those secrets at runtime."
},
"isSelfHosted": {
"type": "boolean",
"description": "Indicates whether this runner is self-hosted (deployed and managed by the workspace/customer). `true` for all runners created via this API. `false` for meshcloud-managed platform runners provisioned automatically by meshStack during deployment \u2014 these cannot be created via this API. This field is read-only.",
"nullable": true
}
},
"description": "All fields in this section describe the configuration of the meshBuildingBlockRunner."
}
}
},
"meshBuildingBlockListV2": {
"title": "meshBuildingBlockListV2",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Contains the self link and pagination links (first, last, next, prev)."
},
"_embedded": {
"required": [
"meshBuildingBlocks"
],
"type": "object",
"properties": {
"meshBuildingBlocks": {
"type": "array",
"description": "List of meshBuildingBlocks.",
"items": {
"required": [
"apiVersion",
"kind",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block and the workspace it belongs to."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionVersionRef",
"displayName",
"inputs",
"parentBuildingBlocks",
"targetRef"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "List of parent Building Blocks, which are set on the Building Block.",
"items": {
"required": [
"buildingBlockUuid",
"definitionUuid"
],
"type": "object",
"properties": {
"buildingBlockUuid": {
"type": "string",
"description": "The UUID of the parent Building Block."
},
"definitionUuid": {
"type": "string",
"description": "The UUID of the Building Block Definition of the parent Building Block."
}
}
}
},
"targetRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshTenant\""
},
"uuid": {
"type": "string",
"description": "The uuid of the tenant for this Building Block"
}
},
"description": "The reference to either a tenant or workspace the Building Block is located on."
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"updateableByConsumer",
"valueType"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data.",
"nullable": true
},
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether this input can be updated by the consumer."
},
"value": {
"type": "string",
"description": "The value of this input. For sensitive inputs, this is a SecretEmbedded object containing only a 'hash' field (plaintext is never returned in responses).",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the input as defined on the Building Block Definition.",
"nullable": true
}
}
}
},
"description": "Map of input keys to their input data."
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block as it is shown in meshPanel."
},
"buildingBlockDefinitionVersionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockDefinitionVersion\""
},
"uuid": {
"type": "string",
"description": "The uuid of the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "The reference to the meshBuildingBlockDefinitionVersion for this Building Block"
}
},
"description": "All fields in this section describe the Building Block."
},
"status": {
"required": [
"forcePurge",
"lifecycle",
"outputs",
"status"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the date when a user requested the deletion is provided via this field. e.g. `2020-12-22T09:37:43Z`",
"nullable": true
},
"deletedOn": {
"type": "string",
"description": "If the Building Block has been deleted, the date when it was deleted.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block. ACTIVE, MARKED_FOR_DELETION or DELETED."
},
"createdOn": {
"type": "string",
"description": "The date when the Building Block was created (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
}
},
"description": "Lifecycle information of the Building Block."
},
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"valueType"
],
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": "The data type of the value. One of STRING, CODE, INTEGER, BOOLEAN, FILE, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value of this output.",
"nullable": true
},
"assignmentType": {
"type": "string",
"description": "The assignment type of the output as defined on the Building Block Definition. One of NONE, PLATFORM_TENANT_ID, SIGN_IN_URL, RESOURCE_URL, SUMMARY.",
"nullable": true
}
}
}
},
"description": "Map of output keys to their output data."
},
"forcePurge": {
"type": "boolean",
"description": "Indicates whether this building block was marked to be purged."
},
"latestRunUuid": {
"type": "string",
"description": "The UUID of the latest meshBuildingBlockRun for this Building Block. This field is null when the caller's permissions are not sufficient to view runs \u2014 for example, when the API key has workspace-scoped access only and the Building Block Definition does not have run transparency enabled.",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, WAITING_FOR_USER_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED, ABORTED."
}
},
"description": "All fields in this section describe the current status of the Building Block."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"api-meshobjects-meshplatforms-uuid-1009187272": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef",
"quotaDefinitions"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"accessInformation": {
"type": "string",
"description": "Optional access information note in Markdown format shown to platform consumers.",
"nullable": true
},
"quotaDefinitions": {
"type": "array",
"description": "List of platform quota definitions. Quota definitions define the available quotas that can be configured for tenants on this platform. Currently only supported for platform types: OPENSHIFT, KUBERNETES, AZURE_KUBERNETES_SERVICE, CLOUDFOUNDRY, OPENSTACK. For platforms that don't support it yet, you have to provide an empty array. If empty list is provided, all existing quota definitions are removed.",
"items": {
"required": [
"autoApprovalThreshold",
"description",
"label",
"maxValue",
"minValue",
"quotaKey"
],
"type": "object",
"properties": {
"quotaKey": {
"type": "string",
"description": "The key of the quota as it is required by the cloud platform."
},
"minValue": {
"type": "number",
"description": "Minimum allowed value for this quota."
},
"unit": {
"type": "string",
"description": "Unit of measurement for the quota (e.g., 'cores', 'GB', 'requests'). Must match the unit expected by the cloud platform.",
"nullable": true
},
"autoApprovalThreshold": {
"type": "number",
"description": "Threshold below which quota requests are automatically approved."
},
"maxValue": {
"type": "number",
"description": "Maximum allowed value for this quota."
},
"description": {
"type": "string",
"description": "Detailed description of what this quota controls."
},
"label": {
"type": "string",
"description": "Human-readable label for the quota."
}
}
}
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
},
"name": {
"type": "string",
"description": "The identifier of the location."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"publicationState",
"restriction"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"readme": {
"type": "string",
"description": "README about the meshPlatform in markdown format",
"nullable": true
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client config for metering"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for Kubernetes"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure Resource Group"
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"gcpRoleMappings",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"serviceAccount",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"gcpRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"gcpRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"gcpRole": {
"type": "string",
"description": "GCP role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP API access"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
},
"metering": {
"required": [
"bigqueryTable",
"partitionTimeColumn",
"processing",
"serviceAccount"
],
"type": "object",
"properties": {
"partitionTimeColumn": {
"type": "string",
"description": "Column name for partitioning time-based data"
},
"additionalFilter": {
"type": "string",
"description": "Additional SQL filter for billing data (optional)",
"nullable": true
},
"bigqueryTableForCarbonFootprint": {
"type": "string",
"description": "BigQuery table containing carbon footprint data (optional)",
"nullable": true
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"carbonFootprintDataCollectionStartMonth": {
"type": "string",
"description": "Start month for carbon footprint data collection (optional)",
"nullable": true
},
"bigqueryTable": {
"type": "string",
"description": "BigQuery table containing billing data export"
},
"serviceAccount": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account for metering, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider for metering access."
}
},
"description": "Service account workload identity configuration for metering (required when type is 'workloadIdentity')"
},
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Base64 encoded credentials.json file for metering service account. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of service account authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Configuration of the service account used for GCP metering API access"
}
},
"description": "Metering configuration for GCP (optional, but required for metering)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"custom": {
"required": [
"platformTypeRef"
],
"type": "object",
"properties": {
"platformTypeRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatformType' for this ref."
},
"name": {
"type": "string",
"description": "Identifier of the custom platform type"
}
},
"description": "Reference to the specific custom platform type to use"
},
"metering": {
"required": [
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for custom platforms"
}
},
"description": "Custom platforms don't have a replicator configuration and only support defining a platformType and basic metering."
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"openshiftRoleMappings": {
"type": "array",
"description": "Role mappings for GCP with project role references",
"items": {
"required": [
"openshiftRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"openshiftRole": {
"type": "string",
"description": "OpenShift role to assign"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identifier of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"metering": {
"required": [
"clientConfig",
"processing"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Access token for Kubernetes API authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Kubernetes client configuration for metering access"
}
},
"description": "Metering configuration for OpenShift (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of AKS authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator EntraID access to manage groups that are used for RBAC in the AKS cluster."
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the Kubernetes service account for replicator access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"metering": {
"required": [
"clientConfig"
],
"type": "object",
"properties": {
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
}
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Access Token of the service account for metering access. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Replication configuration for AKS (optional, but required for metering)"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Configuration for Azure Kubernetes Service (AKS)"
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"accountNamePattern": {
"type": "string",
"description": "Defines the pattern for the AWS account name. If none provided, uses default of '#{workspaceIdentifier}.#{projectIdentifier}'.",
"nullable": true
},
"awsIdentityStore": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"identityStoreId",
"signInUrl"
],
"type": "object",
"properties": {
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign-in URL that end-users must use to log in to the AWS Management Console via AWS IAM Identity Center."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS IAM Identity Center permission set.",
"items": {
"required": [
"awsRole",
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"awsRole": {
"type": "string",
"description": "The name of the AWS role alias used as a suffix in the group name pattern."
},
"permissionSetArns": {
"type": "array",
"description": "The ARNs of the AWS IAM Identity Center permission sets to assign to the group. At least one permission set ARN is required.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
},
"identityStoreId": {
"type": "string",
"description": "The ID of the AWS IAM Identity Center Identity Store associated with this instance. E.g. d-1234567890. You can find this in the AWS IAM Identity Center console."
}
},
"description": "AWS IAM Identity Center integration using the AWS Identity Store API. This is an alternative to the SCIM-based awsSso integration that requires no long-lived SCIM bearer token and is fully compatible with Workload Identity Federation (WIF). Only one of awsSso or awsIdentityStore may be configured at a time. If neither is configured, IAM/group replication is disabled (IAM type 'None')."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later. "
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role. ",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys."
},
"awsSso": {
"required": [
"arn",
"awsRoleMappings",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The AWS IAM Identity Center SCIM Access Token. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS role.",
"items": {
"required": [
"permissionSetArns",
"projectRoleRef"
],
"type": "object",
"properties": {
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Must always be set to `meshProjectRole`"
},
"name": {
"type": "string",
"description": "The identifier of the meshProjectRole, e.g. `admin` or `user` or `reader`"
}
},
"description": "A reference to an existing meshProjectRole"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration. Configure this to use the legacy SCIM-based IAM integration. Leave both awsSso and awsIdentityStore unset to disable IAM/group replication (IAM type 'None')."
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"metering": {
"required": [
"accessConfig",
"filter",
"processing",
"reservedInstanceFairChargeback",
"savingsPlanFairChargeback"
],
"type": "object",
"properties": {
"filter": {
"type": "string",
"description": "Cost Explorer filter type. NONE includes all costs, EXCLUDE_TAX filters out tax charges."
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
},
"accessConfig": {
"required": [
"auth",
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role for metering access."
},
"auth": {
"required": [
"type"
],
"type": "object",
"properties": {
"workloadIdentity": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role for metering access via workload identity federation"
}
},
"description": "Workload identity configuration (required when type is 'workloadIdentity')"
},
"credential": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "AWS secret key for metering service user. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"accessKey": {
"type": "string",
"description": "AWS access key for metering service user"
}
},
"description": "Service user credentials configuration (required when type is 'credential')"
},
"type": {
"type": "string",
"description": "Type of AWS authentication configuration. Possible values: 'credential', 'workloadIdentity'."
}
},
"description": "Authentication configuration for AWS metering access"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId for enhanced security when assuming the organization root account role for metering.",
"nullable": true
}
},
"description": "AWS access configuration for metering"
},
"savingsPlanFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for savings plans"
},
"reservedInstanceFairChargeback": {
"type": "boolean",
"description": "Whether to enable fair chargeback for reserved instances"
}
},
"description": "Metering configuration for AWS (optional, but required for metering)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "Configuration for AWS"
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"azureRoleMappings",
"groupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"updateSubscriptionName",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"azureRoleMappings": {
"type": "array",
"description": "Role mappings for Azure with project role references",
"items": {
"required": [
"azureRole",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRole": {
"required": [
"alias",
"id"
],
"type": "object",
"properties": {
"alias": {
"type": "string",
"description": "Alias for the Azure role"
},
"id": {
"type": "string",
"description": "ID of the Azure role"
}
},
"description": "Azure role"
},
"projectRoleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project role"
}
},
"description": "Reference to a meshProject role"
}
}
}
},
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for replicator access."
},
"updateSubscriptionName": {
"type": "boolean",
"description": "Configures whether subscription names should be updated to match the subscription name pattern during replication."
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"auth",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure Graph API authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the source service principal for replicator access to a customer agreement. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
},
"metering": {
"required": [
"processing",
"servicePrincipal"
],
"type": "object",
"properties": {
"servicePrincipal": {
"required": [
"auth",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Client ID of the service principal for metering"
},
"auth": {
"required": [
"credential",
"type"
],
"type": "object",
"properties": {
"credential": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "Must be set if and only if type is 'credential'. The client secret required for authenticating the configured Service Principal. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"type": {
"type": "string",
"description": "Type of Azure service principal authentication configuration. Possible values: 'credential', 'workloadIdentity'. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
}
},
"description": "Authentication configuration for the service principal. When using workload identity (type='workloadIdentity'), no additional configuration details are required."
},
"objectId": {
"type": "string",
"description": "Object ID of the service principal for metering"
}
},
"description": "Service principal configuration for metering access"
},
"processing": {
"type": "object",
"properties": {
"compactTimelinesAfterDays": {
"type": "number",
"description": "Number of days after which timeline data is compacted",
"nullable": true
},
"deleteRawDataAfterDays": {
"type": "number",
"description": "Number of days after which raw metering data is deleted",
"nullable": true
}
},
"description": "Processing configuration for metering data"
}
},
"description": "Metering configuration for Azure (optional, but required for metering)"
}
},
"description": "Configuration for Azure"
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
}
}
},
"meshBuildingBlockDefinitionPostV1": {
"title": "meshBuildingBlockDefinitionPostV1",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition.",
"nullable": true
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the Building Block Definition. Keep in mind, that values are an array.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition. It also contains additional meta information like the Building Block Definition creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this endpoint."
},
"spec": {
"required": [
"description",
"displayName",
"targetType",
"useInLandingZonesOnly"
],
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the Building Block Definition as it is shown in meshPanel.",
"nullable": true
},
"documentationUrl": {
"type": "string",
"description": "The URL pointing to documentation of the Building Block Definition. (optional)",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block Definition as it is shown in meshPanel."
},
"supportUrl": {
"type": "string",
"description": "The URL pointing to support of the Building Block Definition. (optional)",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the Building Block Definition as it is shown in meshPanel."
},
"targetType": {
"type": "string",
"description": "The type of Building Block Definition. (One of ['TENANT_LEVEL', 'WORKSPACE_LEVEL'.])"
},
"runTransparency": {
"type": "boolean",
"description": "Specifies the Building Block Definition run control. When set to true, both platform teams and workspace users can view detailed run logs and re-run building blocks. When set to false (default), only platform teams have this access.",
"nullable": true
},
"supportedPlatforms": {
"type": "array",
"description": "Set of the platform types this Building Block Definition supports. Must be non-empty if targetType is 'TENANT_LEVEL', otherwise null. Each entry is a meshPlatformType reference.",
"items": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object. Must be 'meshPlatformType'."
},
"name": {
"type": "string",
"description": "The unique identifier of the platform type (corresponds to the `metadata.name` of a meshPlatformType)."
}
}
}
},
"notificationSubscriberUsernames": {
"type": "array",
"description": "A set of usernames or emails that should be notified as subscribers for this Building Block Definition. Prefix entries with `user:` or `email:`.",
"nullable": true,
"items": {
"type": "string"
}
},
"useInLandingZonesOnly": {
"type": "boolean",
"description": "Indicates whether this Building Block Definition should be used on Landing Zones only."
}
},
"description": "All fields in this section describe the Building Block Definition."
},
"status": {
"required": [
"latestVersion",
"latestVersionUuid",
"lifecycle",
"versions"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the date when a user requested the deletion is provided via this field (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block Definition. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information about the Building Block Definition."
},
"latestReleasedVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"versions": {
"type": "array",
"description": "List of meshBuildingBlockDefinitionVersions, which exist for the Building Block Definition.",
"items": {
"required": [
"state",
"versionNumber",
"versionUuid"
],
"type": "object",
"properties": {
"versionUuid": {
"type": "string",
"description": "The uuid of the listed version."
},
"state": {
"type": "string",
"description": "The state of the listed version. (One of ['DRAFT', 'RELEASED'])"
},
"versionNumber": {
"type": "number",
"description": "The number of the listed version."
}
}
}
},
"latestReleasedVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"latestVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition including a possible draft version."
},
"usageCount": {
"type": "number",
"description": "The number of Building Blocks using this Building Block Definition.",
"nullable": true
},
"latestVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition including a possible draft version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition."
}
}
},
"meshProjectRoleV1": {
"title": "meshProjectRoleV1",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"tags"
],
"type": "object",
"properties": {
"deletedAt": {
"type": "string",
"description": "Timestamp when the meshProjectRole was marked for deletion. Only present if the role is deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The name to uniquely identify the meshProjectRole."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshProjectRole. Keep in mind, that values are an array."
}
},
"description": "Always contains the 'name' to uniquely identify the meshProjectRole."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProjectRole datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "currently only provides a self link."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this endpoint."
},
"spec": {
"required": [
"name",
"rank"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The display name of the meshProjectRole."
},
"rank": {
"type": "number",
"description": "The rank of the role. Higher values represent greater privileges. Ranks are used to order project roles, with higher-privilege roles appearing above lower-privilege ones."
},
"description": {
"type": "string",
"description": "A detailed description of the meshProjectRole and its permissions.",
"nullable": true
}
},
"description": "All fields in this section describe the meshProjectRole."
}
}
},
"meshBuildingBlockDefinitionPutV1": {
"title": "meshBuildingBlockDefinitionPutV1",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition.",
"nullable": true
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the Building Block Definition. Keep in mind, that values are an array.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition. It also contains additional meta information like the Building Block Definition creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this endpoint."
},
"spec": {
"required": [
"description",
"displayName",
"targetType",
"useInLandingZonesOnly"
],
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The symbol of the Building Block Definition as it is shown in meshPanel.",
"nullable": true
},
"documentationUrl": {
"type": "string",
"description": "The URL pointing to documentation of the Building Block Definition. (optional)",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the Building Block Definition as it is shown in meshPanel."
},
"supportUrl": {
"type": "string",
"description": "The URL pointing to support of the Building Block Definition. (optional)",
"nullable": true
},
"description": {
"type": "string",
"description": "The description of the Building Block Definition as it is shown in meshPanel."
},
"targetType": {
"type": "string",
"description": "The type of Building Block Definition. (One of ['TENANT_LEVEL', 'WORKSPACE_LEVEL'.])"
},
"runTransparency": {
"type": "boolean",
"description": "Specifies the Building Block Definition run control. When set to true, both platform teams and workspace users can view detailed run logs and re-run building blocks. When set to false (default), only platform teams have this access.",
"nullable": true
},
"supportedPlatforms": {
"type": "array",
"description": "Set of the platform types this Building Block Definition supports. Must be non-empty if targetType is 'TENANT_LEVEL', otherwise null. Each entry is a meshPlatformType reference.",
"items": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object. Must be 'meshPlatformType'."
},
"name": {
"type": "string",
"description": "The unique identifier of the platform type (corresponds to the `metadata.name` of a meshPlatformType)."
}
}
}
},
"notificationSubscriberUsernames": {
"type": "array",
"description": "A set of usernames or emails that should be notified as subscribers for this Building Block Definition. Prefix entries with `user:` or `email:`.",
"nullable": true,
"items": {
"type": "string"
}
},
"useInLandingZonesOnly": {
"type": "boolean",
"description": "Indicates whether this Building Block Definition should be used on Landing Zones only."
}
},
"description": "All fields in this section describe the Building Block Definition."
},
"status": {
"required": [
"latestVersion",
"latestVersionUuid",
"lifecycle",
"versions"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the date when a user requested the deletion is provided via this field (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the Building Block Definition. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information about the Building Block Definition."
},
"latestReleasedVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"versions": {
"type": "array",
"description": "List of meshBuildingBlockDefinitionVersions, which exist for the Building Block Definition.",
"items": {
"required": [
"state",
"versionNumber",
"versionUuid"
],
"type": "object",
"properties": {
"versionUuid": {
"type": "string",
"description": "The uuid of the listed version."
},
"state": {
"type": "string",
"description": "The state of the listed version. (One of ['DRAFT', 'RELEASED'])"
},
"versionNumber": {
"type": "number",
"description": "The number of the listed version."
}
}
}
},
"latestReleasedVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition not including a possible draft version.",
"nullable": true
},
"latestVersion": {
"type": "number",
"description": "The number of the latest version based on this Building Block Definition including a possible draft version."
},
"usageCount": {
"type": "number",
"description": "The number of Building Blocks using this Building Block Definition.",
"nullable": true
},
"latestVersionUuid": {
"type": "string",
"description": "The uuid of the latest version based on this Building Block Definition including a possible draft version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition."
}
}
},
"meshBuildingBlockRunner-Post": {
"title": "meshBuildingBlockRunner-Post",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"lastSeen": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner last connected to meshStack (ISO 8601 format). This is updated automatically whenever the runner polls for work.",
"nullable": true
},
"createdOn": {
"type": "string",
"description": "The timestamp when this meshBuildingBlockRunner was created (ISO 8601 format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies this meshBuildingBlockRunner. Must not be provided on creation \u2014 meshStack assigns a UUID automatically. On update (PUT), this field is mandatory and must match the UUID in the path parameter.",
"nullable": true
},
"lastKnownVersion": {
"type": "string",
"description": "The last runner version reported via the X-Meshcloud-Runner-Version request header when polling for work. Null if the runner has never sent a version header.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshBuildingBlockRunner."
}
},
"description": "Contains identifying properties of the meshBuildingBlockRunner."
},
"apiVersion": {
"type": "string",
"description": "Version of meshBuildingBlockRunner datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockRunner' for this endpoint."
},
"spec": {
"required": [
"displayName",
"implementationType",
"publicKey"
],
"type": "object",
"properties": {
"implementationType": {
"type": "string",
"description": "The type of building block implementation this runner handles. Possible values: `TERRAFORM`, `GITHUB_WORKFLOW`, `GITLAB_PIPELINE`, `AZURE_DEVOPS_PIPELINE`, `MANUAL`."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of this meshBuildingBlockRunner."
},
"restriction": {
"type": "string",
"description": "Visibility restriction of this runner. `PUBLIC` makes the runner available to all workspaces in meshStack. `PRIVATE` (default) restricts it to the owning workspace. Only administrators can create or update runners with `PUBLIC` restriction.",
"nullable": true
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the GCP federated token, e.g. `/var/run/secrets/workload-identity/gcp/token`."
},
"audience": {
"type": "string",
"description": "The audience for the GCP Workload Identity Federation token, e.g. `//iam.googleapis.com/projects/123/locations/global/workloadIdentityPools/my-pool/providers/my-provider`."
}
},
"description": "GCP-specific Workload Identity Federation configuration for this runner."
},
"subject": {
"type": "string",
"description": "The subject claim of the OIDC token issued to this runner, e.g. `system:serviceaccount:meshfed:my-runner`."
},
"aws": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the AWS federated token, e.g. `/var/run/secrets/workload-identity/aws/token`."
},
"audience": {
"type": "string",
"description": "The audience for the AWS STS AssumeRoleWithWebIdentity call, typically `sts.amazonaws.com`."
},
"thumbprint": {
"type": "string",
"description": "Optional thumbprint of the OIDC provider's root CA certificate for AWS.",
"nullable": true
}
},
"description": "AWS-specific Workload Identity Federation configuration for this runner."
},
"issuer": {
"type": "string",
"description": "The OIDC issuer URL of the identity provider that issues tokens for this runner. This is used to configure trust with the target cloud provider."
},
"azure": {
"required": [
"audience",
"tokenPath"
],
"type": "object",
"properties": {
"tokenPath": {
"type": "string",
"description": "The file system path where the runner writes the Azure federated token, e.g. `/var/run/secrets/workload-identity/azure/token`."
},
"audience": {
"type": "string",
"description": "The audience for the Azure federated identity token exchange, typically `api://AzureADTokenExchange`."
}
},
"description": "Azure-specific Workload Identity Federation configuration for this runner."
}
},
"description": "Optional Workload Identity Federation (WIF) configuration for this runner. When configured, the runner can authenticate to cloud providers using short-lived tokens instead of long-lived credentials. At least one of `gcp`, `aws`, or `azure` must be provided."
},
"publicKey": {
"type": "string",
"description": "The RSA public key (PEM-encoded) used to encrypt secrets that are sent to this runner. Accepts either a PEM-encoded public key (BEGIN PUBLIC KEY) or an X.509 certificate (BEGIN CERTIFICATE). The runner uses the corresponding private key to decrypt those secrets at runtime."
},
"isSelfHosted": {
"type": "boolean",
"description": "Indicates whether this runner is self-hosted (deployed and managed by the workspace/customer). `true` for all runners created via this API. `false` for meshcloud-managed platform runners provisioned automatically by meshStack during deployment \u2014 these cannot be created via this API. This field is read-only.",
"nullable": true
}
},
"description": "All fields in this section describe the configuration of the meshBuildingBlockRunner."
}
}
},
"meshLocation-Post": {
"title": "meshLocation-Post",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier that uniquely identifies the meshLocation."
},
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the meshLocation. This is a common attribute for all meshObjects, but in case of a meshLocation it is not used for referencing the location. Instead the name (identifier) is used.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this location."
}
},
"description": "Contains the identifiers for the meshLocation."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLocation datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshLocation."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLocation' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the meshLocation shown in the UI."
},
"description": {
"type": "string",
"description": "An optional description of the meshLocation.",
"nullable": true
}
},
"description": "All fields in this section describe the meshLocation configuration."
},
"status": {
"required": [
"isPublic"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the meshLocation was deleted. Null if the location has not been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the meshLocation. Possible values are: ACTIVE, DEACTIVATED, DELETED."
},
"createdOn": {
"type": "string",
"description": "The timestamp when the meshLocation was created."
}
},
"description": "The lifecycle status of the meshLocation."
},
"isPublic": {
"type": "boolean",
"description": "Indicates whether the location has any public platform instances associated with it."
}
},
"description": "The current status of the meshLocation."
}
}
},
"meshApiKey-Post": {
"title": "meshApiKey-Post",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"description": "Timestamp when the API key was created (ISO-8601 instant format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "UUID of the API key.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "Identifier of the workspace that owns this API key."
}
},
"description": "Metadata that identifies and scopes the meshApiKey."
},
"apiVersion": {
"type": "string",
"description": "Version of meshApiKey datatype. For this endpoint this is always 'v1-preview'."
},
"_links": {
"type": "object",
"description": "Available links on a meshApiKey."
},
"kind": {
"type": "string",
"description": "The meshObject kind. For this endpoint this is always 'meshApiKey'."
},
"spec": {
"required": [
"displayName",
"permissions"
],
"type": "object",
"properties": {
"permissions": {
"type": "array",
"description": "Set of permission short-codes assigned to this API key.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"displayName": {
"type": "string",
"description": "Display name of the API key."
},
"expiresAt": {
"type": "string",
"description": "Expiration date of the API key (ISO-8601 date format, e.g. 2025-12-31). Nullable if the key does not expire.",
"nullable": true
}
},
"description": "Configuration of the meshApiKey."
},
"status": {
"required": [
"clientId",
"clientSecret"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The clientId used for authentication. Same as metadata.uuid."
},
"clientSecret": {
"type": "string",
"description": "The clientSecret used for authentication. Only included on creation (POST) or when the secret is rotated due to an expiresAt change (PUT). Omitted on GET."
}
},
"description": "Status information including clientId and the clientSecret (only on creation or key rotation)."
}
}
},
"api-meshobjects-meshbuildingblockdefinitionversions-uuid92336749": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition Version.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition Version belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition Version. It also contains additional meta information like the version creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition Version datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinitionVersion' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionRef",
"deletionMode",
"implementation",
"inputs",
"onlyApplyOncePerTenant",
"outputs",
"runnerRef",
"state",
"versionNumber"
],
"type": "object",
"properties": {
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"type"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable display name for the output."
},
"type": {
"type": "string",
"description": "Data type of the output (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE'])."
},
"assignmentType": {
"type": "string",
"description": "How the output is used (One of ['NONE', 'PLATFORM_TENANT_ID', 'SIGN_IN_URL', 'RESOURCE_URL', 'SUMMARY'])."
}
}
}
},
"description": "Map of output definitions for this Building Block Definition Version. The map's keys are output keys, the values are output definition objects. For manual Building Block Definitions, there must not be any outputs that do not match an input with the same key. For manual Building Block Definitions, the type of outputs must match the one from the input with the same key, but must be translated from SINGLE_SELECT to STRING and from MULTI_SELECT to CODE. "
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"isEnvironment",
"isSensitive",
"type",
"updateableByConsumer"
],
"type": "object",
"properties": {
"argument": {
"type": "object",
"description": "Argument value for the input. Required if assignment type is 'STATIC'\nor 'BUILDING_BLOCK_OUTPUT'.\nFor 'BUILDING_BLOCK_OUTPUT', the value must be a string in the\nformat `.` referencing an output of a parent building block.\nMust match the input type if provided. If input type is 'CODE',\nthe value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of\n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"valueValidationRegex": {
"type": "string",
"description": "Regular expression pattern to validate input values. (optional)",
"nullable": true
},
"defaultValue": {
"type": "object",
"description": "Default value for the input (optional). Must match the input type if provided.\nIf input type is 'CODE', the value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of \n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data that should be encrypted."
},
"displayName": {
"type": "string",
"description": "Human-readable display name for the input."
},
"description": {
"type": "string",
"description": "Description explaining the purpose and usage of the input. (optional)",
"nullable": true
},
"selectableValues": {
"type": "array",
"description": "Set of allowed values for the input in case the type is one of 'SINGLE_SELECT' or 'MULTI_SELECT'. (Must be either null or an empty array.)",
"nullable": true,
"items": {
"type": "string"
}
},
"validationRegexErrorMessage": {
"type": "string",
"description": "Error message to display when regex validation fails. (optional)",
"nullable": true
},
"isEnvironment": {
"type": "boolean",
"description": "Whether this input is exposed as a regular or environment variable."
},
"type": {
"type": "string",
"description": "Data type of the input (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE', 'SINGLE_SELECT', 'MULTI_SELECT'])."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether the input value can be updated by the consumer that does not have admin or platform operator permissions."
},
"assignmentType": {
"type": "string",
"description": "How the input value is assigned (One of ['AUTHOR', 'USER_INPUT', 'PLATFORM_OPERATOR_MANUAL_INPUT', 'BUILDING_BLOCK_OUTPUT', 'PLATFORM_TENANT_ID', 'WORKSPACE_IDENTIFIER', 'PROJECT_IDENTIFIER', 'FULL_PLATFORM_IDENTIFIER', 'TENANT_BUILDING_BLOCK_UUID', 'STATIC', 'USER_PERMISSIONS'])."
}
}
}
},
"description": "Map of input definitions for this Building Block Definition Version. The map's keys are input keys, the values are input definition objects."
},
"permissions": {
"type": "array",
"description": "List of [permission short codes](/api/authentication/api-permissions) that the [ephemeral API key](/concepts/building-block/#ephemeral-api-keys) of a Building Block using this version will receive. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"implementation": {
"required": [
"azureDevOpsPipeline",
"githubWorkflows",
"gitlabPipeline",
"terraform",
"type"
],
"type": "object",
"properties": {
"azureDevOpsPipeline": {
"required": [
"async",
"integrationRef",
"pipelineId",
"project"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"project": {
"type": "string",
"description": "The Azure DevOps project containing the pipeline."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced Azure DevOps integration."
}
},
"description": "The reference to the meshIntegration for this Azure DevOps implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use for the Azure DevOps pipeline run.",
"nullable": true
},
"pipelineId": {
"type": "string",
"description": "The ID of the Azure DevOps pipeline to run."
}
},
"description": "Azure DevOps Pipeline Implementation details for this version."
},
"gitlabPipeline": {
"required": [
"integrationRef",
"pipelineTriggerToken",
"projectId",
"refName"
],
"type": "object",
"properties": {
"pipelineTriggerToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The pipeline trigger token used to trigger the GitLab pipeline. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitLab integration."
}
},
"description": "The reference to the meshIntegration for this GitLab implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use."
},
"projectId": {
"type": "string",
"description": "The GitLab project ID containing the pipeline."
}
},
"description": "GitLab Pipeline Implementation details for this version."
},
"terraform": {
"required": [
"async",
"repositoryUrl",
"sshPrivateKey",
"terraformVersion"
],
"type": "object",
"properties": {
"useMeshHttpBackendFallback": {
"type": "boolean",
"description": "Whether to use the Mesh HTTP backend for state storage.",
"nullable": true
},
"terraformVersion": {
"type": "string",
"description": "The version of Terraform / OpenTofu to use."
},
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"sshKnownHost": {
"required": [
"host",
"keyType",
"keyValue"
],
"type": "object",
"properties": {
"keyValue": {
"type": "string",
"description": "The SSH public key value of the Git server."
},
"host": {
"type": "string",
"description": "The hostname of the Git server."
},
"keyType": {
"type": "string",
"description": "The type of the SSH key (e.g., ssh-rsa, ssh-ed25519)."
}
},
"description": "The known host configuration for SSH access to the Git repository."
},
"sshPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "SSH private key used to access the Git repository. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"preRunScript": {
"type": "string",
"description": "An optional shell script (max 16 KiB) executed before each Terraform / OpenTofu run inside the runner container. Use this to perform setup tasks such as installing dependencies or configuring credentials.",
"nullable": true
},
"repositoryPath": {
"type": "string",
"description": "The path within the Git repository to the Terraform / OpenTofu configuration.",
"nullable": true
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use.",
"nullable": true
},
"repositoryUrl": {
"type": "string",
"description": "The URL of the Git repository containing the Terraform / OpenTofu configuration."
}
},
"description": "Terraform / OpenTofu Implementation details for this version."
},
"type": {
"type": "string",
"description": "The type of implementation (, , , , , , , , , )."
},
"githubWorkflows": {
"required": [
"applyWorkflow",
"async",
"branch",
"integrationRef",
"omitRunObjectInput",
"repository"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"destroyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to destroy the building block.",
"nullable": true
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitHub integration."
}
},
"description": "The reference to the meshIntegration for this GitHub implementation."
},
"applyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to apply the building block."
},
"repository": {
"type": "string",
"description": "The GitHub repository containing the workflows."
},
"branch": {
"type": "string",
"description": "The branch of the GitHub repository to use."
},
"omitRunObjectInput": {
"type": "boolean",
"description": "Whether to omit the run object input when triggering the workflow."
}
},
"description": "GitHub Workflows Implementation details for this version."
}
},
"description": "The implementation details of the Building Block Definition Version. The structure of this field depends on the implementation type."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockRunner')."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner."
}
},
"description": "Reference to the Building Block Runner that executes this version."
},
"buildingBlockDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockDefinition')."
},
"uuid": {
"type": "string",
"description": "The UUID of the parent Building Block Definition."
}
},
"description": "Reference to the parent Building Block Definition."
},
"onlyApplyOncePerTenant": {
"type": "boolean",
"description": "Whether this building block can only be applied once per tenant. This is not relevant for Building Blocks on Workspace level."
},
"state": {
"type": "string",
"description": "The state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"dependencyDefinitionUuids": {
"type": "array",
"description": "List of Building Block Definition UUIDs that this version depends on. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"deletionMode": {
"type": "string",
"description": "Specifies how deletion of building blocks based on this version is handled. (One of ['DELETE', 'PURGE'])"
},
"versionNumber": {
"type": "number",
"description": "The version number of this Building Block Definition Version."
}
},
"description": "All fields in this section describe the Building Block Definition Version."
}
}
},
"meshProjectPost": {
"title": "meshProjectPost",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The projectIdentifier as 'name'."
},
"createdOn": {
"type": "string",
"description": "The meshProject has been created at this date (e.g. `2020-12-22T09:37:43Z`).",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspaceIdentifier as 'ownedByWorkspace'."
}
},
"description": "Always contains the 'name' and 'ownedByWorkspace' to uniquely identify the meshProject."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProject datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshProject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProject' for this endpoint."
},
"spec": {
"required": [
"displayName",
"tags"
],
"type": "object",
"properties": {
"substitutePaymentMethodIdentifier": {
"type": "string",
"description": "The substitutePaymentMethod of the meshProject",
"nullable": true
},
"paymentMethodIdentifier": {
"type": "string",
"description": "The meshPaymentMethod of the meshProject.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshProject as it is shown in meshPanel."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshProject. Keep in mind, that values are an array."
}
},
"description": "All fields in this section describe the meshProject."
}
}
},
"api-meshobjects-meshprojects-fullProjectIdentifier-1933825965": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The project identifier that must match the project identifier part of the fullProjectIdentifier in the URL path."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace identifier that must match the workspace identifier part of the fullProjectIdentifier in the URL path."
}
},
"description": "Fixed fields that help to identify the meshProject. The name and ownedByWorkspace must match the fullProjectIdentifier in the URL path."
},
"apiVersion": {
"type": "string",
"description": "Version of meshProject datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProject' for this endpoint."
},
"spec": {
"required": [
"displayName",
"tags"
],
"type": "object",
"properties": {
"substitutePaymentMethodIdentifier": {
"type": "string",
"description": "The substitute payment method of the project.",
"nullable": true
},
"paymentMethodIdentifier": {
"type": "string",
"description": "The payment method of the project.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the project as it is shown in meshPanel."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the project. Keep in mind, that values are an array."
}
},
"description": "All fields in this section describe the project and can be updated."
}
}
},
"api-meshobjects-meshworkspacebindings-userbindings-1470058865": {
"required": [
"apiVersion",
"kind"
],
"type": "object",
"properties": {
"targetRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier of the workspace the user should get assigned to."
}
}
},
"metadata": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of this binding which later can be used to refer to it. It must be globally unique."
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of this object"
},
"kind": {
"type": "string",
"description": "Type of the returned meshObject"
},
"subject": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The username of the referenced user."
}
}
},
"roleRef": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the referenced role for this user."
}
}
}
}
},
"meshPlatform-Get-V1-openshift": {
"title": "meshPlatform-Get-V1-openshift",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"identifier",
"kind"
],
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The identifier of the location."
},
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"marketplaceStatus",
"restriction"
],
"type": "object",
"properties": {
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"marketplaceStatus": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"namespaceNamePattern"
],
"type": "object",
"properties": {
"namespaceNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Kubernetes Namespace Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for Kubernetes"
}
},
"description": "Replication configuration for Kubernetes (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your Kubernetes Cluster, which is used to call the APIs to create new Kubernetes projects, get raw data for metering the Kubernetes projects, etc. An example base URL is: https://k8s.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the Kubernetes cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for Kubernetes"
},
"gcp": {
"type": "object",
"properties": {
"replication": {
"required": [
"allowHierarchicalFolderAssignment",
"billingAccountId",
"customerId",
"domain",
"groupNamePattern",
"projectIdPattern",
"projectNamePattern",
"roleMappings",
"serviceAccountConfig",
"skipUserGroupPermissionCleanup",
"userLookupStrategy"
],
"type": "object",
"properties": {
"userLookupStrategy": {
"type": "string",
"description": "Users can either be looked up by E-Mail or externalAccountId. This must also be the property that is placed in the external user id (EUID) of your meshUser entity to match. E-Mail is usually a good choice as this is often set up as the EUID throughout all cloud platforms and meshStack. ('email' or 'externalId')"
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The result must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. When length restrictions are applied, the abbreviation will be in the middle and marked by a single-quote."
},
"projectIdPattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. The resulting string must not exceed a total length of 30 characters. Only alphanumeric + hyphen are allowed. We recommend that configuration include at least 3 characters of the random parameter to reduce the chance of naming collisions as the project Ids must be globally unique within GCP."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"domain": {
"type": "string",
"description": "The domain used for cloud identity directory-groups created and managed by meshStack. meshStack maintains separate groups for each meshProject role on each managed GCP project."
},
"serviceAccountConfig": {
"type": "object",
"properties": {
"serviceAccountCredentialsConfig": {
"required": [
"serviceAccountCredentialsB64"
],
"type": "object",
"properties": {
"serviceAccountCredentialsB64": {
"type": "string",
"description": "Base64 encoded credentials.json file for a GCP ServiceAccount. The replicator uses this Service Account to automate GCP API operations (IAM, ResourceManager etc.)."
}
},
"description": "Service account credentials configuration (alternative to serviceAccountWorkloadIdentityConfig)"
},
"serviceAccountWorkloadIdentityConfig": {
"required": [
"audience",
"serviceAccountEmail"
],
"type": "object",
"properties": {
"serviceAccountEmail": {
"type": "string",
"description": "The email address of the Service Account, that gets impersonated for calling Google APIs via Workload Identity Federation."
},
"audience": {
"type": "string",
"description": "The audience associated with your workload identity pool provider."
}
},
"description": "Service account workload identity configuration (alternative to serviceAccountCredentialsConfig)"
}
},
"description": "Service account configuration. Either serviceAccountCredentialsConfig or serviceAccountWorkloadIdentityConfig must be provided."
},
"customerId": {
"type": "string",
"description": "A Google Customer ID. It typically starts with a 'C'."
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for GCP"
},
"allowHierarchicalFolderAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical folder assignment in GCP. If set to true: Projects can be moved to sub folders of the folder defined in the Landing Zone. This is useful if you want to manage the project location with a deeper and more granular hierarchy. If set to false: Projects will always be moved directly to the folder defined in the Landing Zone."
},
"billingAccountId": {
"type": "string",
"description": "The ID of the billing account to associate with all GCP projects managed by meshStack"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the GCP platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"groupNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. Additionally you can also use 'platformGroupAlias' as a placeholder to access the specific project role from the role mappings done in this platform configuration or in the meshLandingZone configuration."
}
},
"description": "Replication configuration for GCP (optional, but required for replication)"
}
},
"description": "Configuration for Google Cloud Platform (GCP)"
},
"azurerg": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"resourceGroupNamePattern",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscription",
"userGroupNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "Administrative unit ID for group placement",
"nullable": true
},
"userGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application"
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "URL that Azure's consent experience redirects users to after invitation acceptance"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, Azure sends Invitation mails to invited users"
}
},
"description": "Optional B2B user invitation configuration"
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Prefix for all labels created by meshStack"
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email')"
},
"subscription": {
"type": "string",
"description": "The Subscription that will contain all the created Resource Groups"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Preserve user groups and replicated permission after tenant deletion"
},
"resourceGroupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name Resource Group managed by meshStack"
}
},
"description": "Replication configuration for Azure Resource Group (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure Resource Group"
},
"openshift": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"clientConfig",
"identityProviderName",
"projectNamePattern"
],
"type": "object",
"properties": {
"webConsoleUrl": {
"type": "string",
"description": "The Web Console URL that is used to redirect the user to the cloud platform. An example Web Console URL is https://console-openshift-console.apps.okd4.dev.eu-de-central.msh.host",
"nullable": true
},
"projectNamePattern": {
"type": "string",
"description": "All the commonly available replicator string template properties are available. OpenShift Project Names must be no longer than 63 characters, must start and end with a lowercase letter or number, and may contain lowercase letters, numbers, and hyphens."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"identityProviderName": {
"type": "string",
"description": "Identity provider name"
},
"roleMappings": {
"required": [
"admin",
"member",
"reader"
],
"type": "object",
"properties": {
"reader": {
"type": "string",
"description": "Role mapping for reader users"
},
"member": {
"type": "string",
"description": "Role mapping for member users"
},
"admin": {
"type": "string",
"description": "Role mapping for admin users"
}
},
"description": "Role mappings for OpenShift"
},
"clientConfig": {
"required": [
"accessToken"
],
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
}
},
"description": "Client configuration for OpenShift"
}
},
"description": "Replication configuration for OpenShift (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "This URL is the base URL to your OpenShift Cluster, which is used to call the APIs to create new OpenShift projects, get raw data for metering the OpenShift projects, etc. An example base URL is: https://api.okd4.dev.eu-de-central.msh.host:6443"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the OpenShift cluster. SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.",
"nullable": true
}
},
"description": "Configuration for OpenShift"
},
"aks": {
"required": [
"baseUrl"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessToken",
"aksClusterName",
"aksResourceGroup",
"aksSubscriptionId",
"groupNamePattern",
"namespaceNamePattern",
"sendAzureInvitationMail",
"servicePrincipal",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"aksSubscriptionId": {
"type": "string",
"description": "Subscription ID for the AKS cluster"
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"entraTenant",
"objectId"
],
"type": "object",
"properties": {
"entraTenant": {
"type": "string",
"description": "Domain name or ID of the Entra Tenant that holds the Service Principal."
},
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID'."
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret for the service principal (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type for the service principal (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for AKS"
},
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation.",
"nullable": true
},
"aksResourceGroup": {
"type": "string",
"description": "Resource group for the AKS cluster"
},
"namespaceNamePattern": {
"type": "string",
"description": "Pattern for naming namespaces in AKS"
},
"userLookUpStrategy": {
"type": "string",
"description": "Strategy for user lookup in Azure ('userPrincipalName' or 'email')"
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "Flag to send Azure invitation emails. When true, meshStack instructs Azure to send out Invitation mails to invited users."
},
"aksClusterName": {
"type": "string",
"description": "Name of the AKS cluster"
},
"accessToken": {
"type": "string",
"description": "The Access Token of the service account for replicator access."
},
"groupNamePattern": {
"type": "string",
"description": "Pattern for naming groups in AKS"
}
},
"description": "Replication configuration for AKS (optional, but required for replication)"
},
"baseUrl": {
"type": "string",
"description": "Base URL of the AKS cluster"
},
"disableSslValidation": {
"type": "boolean",
"description": "Flag to disable SSL validation for the AKS cluster. (SSL Validation should at best never be disabled, but for integration of some private cloud platforms in an early state, they might not yet be using valid SSL certificates. In that case it can make sense to disable SSL validation here to already test integration of these platforms.)",
"nullable": true
}
},
"description": "Configuration for Azure Kubernetes Service (AKS)"
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"aws": {
"required": [
"region"
],
"type": "object",
"properties": {
"replication": {
"required": [
"accessConfig",
"accountAccessRole",
"accountEmailPattern",
"allowHierarchicalOrganizationalUnitAssignment",
"automationAccountRole",
"selfDowngradeAccessRole",
"skipUserGroupPermissionCleanup",
"waitForExternalAvm"
],
"type": "object",
"properties": {
"selfDowngradeAccessRole": {
"type": "boolean",
"description": "Flag for self downgrade access role. If set, meshStack will revoke its rights on the managed account that were only needed for initial account creation."
},
"enrollmentConfiguration": {
"required": [
"accountFactoryProductId",
"managementAccountId"
],
"type": "object",
"properties": {
"managementAccountId": {
"type": "string",
"description": "The Account ID of the management account configured for the platform instance."
},
"accountFactoryProductId": {
"type": "string",
"description": "The Product ID of the AWS Account Factory Product in AWS Service Catalog that should be used for enrollment. Starts with `prod-`."
}
},
"description": "With this optional configuration you can provide general information to enroll the created AWS accounts into Control Tower. Make sure you also enable it on the meshLandingZone!. If you don't, meshStack will skip the enrollment of AWS Accounts into Control Tower."
},
"accountAccessRole": {
"type": "string",
"description": "The name for the Account Access Role that will be rolled out to all managed accounts. Only a name, not an ARN must be set here, as the ARN must be built dynamically for every managed AWS Account. The replicator service user needs to assume this role in all accounts to manage them."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "Namespace prefix for tenant tags"
}
},
"description": "Tenant tags configuration"
},
"automationAccountRole": {
"type": "string",
"description": "ARN of the Automation Account Role. The Automation Account contains all AWS StackSets and Lambda Functions that shall be executed via meshLandingZones. E.g. arn:aws:iam::123456789:role/MeshfedAutomationRole."
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the AWS platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"automationAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the automation account role.",
"nullable": true
},
"accountAliasPattern": {
"type": "string",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously defined the pattern for the AWS account alias.",
"nullable": true
},
"accountEmailPattern": {
"type": "string",
"description": "With a String Pattern you can define how the account email address of the created AWS account will be set. E.g. 'aws++++#+++{workspaceIdentifier}.+++#+++{projectIdentifier}@yourcompany.com'. Please consider that this email address is limited to 64 characters! Also have a look at our docs for more information."
},
"enforceAccountAlias": {
"type": "boolean",
"description": "Deprecated: This field is accepted for API compatibility but is no longer applied during replication. Previously controlled whether the account alias was enforced during replication.",
"nullable": true
},
"waitForExternalAvm": {
"type": "boolean",
"description": "Flag to wait for external AVM.Please use this setting with care! It is currently very specific to certain tags being present on the account! In general, we recommend not to activate this waitForExternalAvm functionality! In a meshLandingZone an AVM can be triggered via an AWS StackSet or via a Lambda Function. If meshStack shall wait for the AVM to complete when creating a new platform tenant, this flag must be checked. meshStack will identify completion of the AVM by checking the presence of the following tags on the AWS account: 'ProductName' is set to workspace identifier and 'Stage' is set to project identifier."
},
"allowHierarchicalOrganizationalUnitAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical organizational unit assignment in AWS. If set to true: Accounts can be moved to child organizational units of the organizational unit defined in the Landing Zone. This is useful if you want to manage the account location with a deeper and more granular hierarchy. If set to false: Accounts will always be moved directly to the organizational unit defined in the Landing Zone."
},
"accessConfig": {
"required": [
"organizationRootAccountRole"
],
"type": "object",
"properties": {
"organizationRootAccountRole": {
"type": "string",
"description": "ARN of the Management Account Role. The Management Account contains your AWS organization. E.g. arn:aws:iam::123456789:role/MeshfedServiceRole."
},
"workloadIdentityConfig": {
"required": [
"roleArn"
],
"type": "object",
"properties": {
"roleArn": {
"type": "string",
"description": "ARN of the role that should be used as the entry point for meshStack by assuming it via web identity."
}
},
"description": "Workload identity configuration (alternative to serviceUserConfig)"
},
"serviceUserConfig": {
"required": [
"accessKey",
"secretKey"
],
"type": "object",
"properties": {
"secretKey": {
"type": "string",
"description": "AWS secret key for service user"
},
"accessKey": {
"type": "string",
"description": "AWS access key for service user"
}
},
"description": "Service user configuration (alternative to workloadIdentityConfig)"
},
"organizationRootAccountExternalId": {
"type": "string",
"description": "ExternalId to enhance security in a multi account setup when assuming the organization root account role.",
"nullable": true
}
},
"description": "meshStack currently supports 2 types of authentication. Workload Identity Federation (using OIDC) is the one that we recommend as it enables secure access to your AWS account without using long lived credentials. Alternatively, you can use credential based authentication by providing access and secret keys. Either the `serviceUserConfig` or `workloadIdentityConfig` must be provided."
},
"awsSso": {
"required": [
"arn",
"groupNamePattern",
"scimEndpoint",
"signInUrl",
"ssoAccessToken"
],
"type": "object",
"properties": {
"ssoAccessToken": {
"type": "string",
"description": "The AWS IAM Identity Center SCIM Access Token that was generated via the Automatic provisioning config in AWS IAM Identity Center."
},
"signInUrl": {
"type": "string",
"description": "The AWS IAM Identity Center sign in Url, that must be used by end-users to log in via AWS IAM Identity Center to AWS Management Console."
},
"roleMappings": {
"type": "object",
"properties": {
"member": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for member role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for member role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
},
"admin": {
"required": [
"awsRoleName",
"permissionSetArns"
],
"type": "object",
"properties": {
"awsRoleName": {
"type": "string",
"description": "AWS role name for admin role mapping"
},
"permissionSetArns": {
"type": "array",
"description": "Permission set ARNs for admin role mapping",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}
}
},
"description": "Role mappings for AWS SSO"
},
"scimEndpoint": {
"type": "string",
"description": "The SCIM endpoint you can find in your AWS IAM Identity Center Automatic provisioning config."
},
"arn": {
"type": "string",
"description": "The ARN of your AWS IAM Identity Center Instance. E.g. arn:aws:sso:::instance/ssoins-123456789abc."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AWS IAM Identity Center groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names will be unique within the same AWS IAM Identity Center Instance with that configuration."
}
},
"description": "AWS SSO configuration"
}
},
"description": "Replication configuration for AWS (optional, but required for replication)"
},
"region": {
"type": "string",
"description": "AWS region"
}
},
"description": "Configuration for AWS"
},
"azure": {
"required": [
"entraTenant"
],
"type": "object",
"properties": {
"replication": {
"required": [
"groupNamePattern",
"roleMappings",
"servicePrincipal",
"skipUserGroupPermissionCleanup",
"subscriptionNamePattern",
"userLookUpStrategy"
],
"type": "object",
"properties": {
"administrativeUnitId": {
"type": "string",
"description": "If you enter an administrative unit ID the replicated (and potentially existing) groups will be put into this AU. This can be used to limit the permission scopes which are required for the replicator principal. If you remove the AU ID again or change it, the groups will not be removed from the old AU.",
"nullable": true
},
"servicePrincipal": {
"required": [
"authType",
"clientId",
"objectId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the 'Enterprise Application' but can also be retrieved via the 'App Registration' object as 'Application (Client) ID"
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Client secret (required if authType is CREDENTIALS)",
"nullable": true
},
"authType": {
"type": "string",
"description": "Authentication type (CREDENTIALS or WORKLOAD_IDENTITY)"
},
"objectId": {
"type": "string",
"description": "The Object ID of the Enterprise Application. You can get this Object ID via the API (e.g. when using our Terraform provider) or from Enterprise applications pane in Microsoft Entra admin center."
}
},
"description": "Service principal configuration for Azure"
},
"b2bUserInvitation": {
"required": [
"redirectUrl",
"sendAzureInvitationMail"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "This is the URL that Azure's consent experience redirects users to after they accept their invitation."
},
"sendAzureInvitationMail": {
"type": "boolean",
"description": "When true, meshStack instructs Azure to send out Invitation mails to invited users. These mails allow users to redeem their invitation to the AAD tenant only using email and Azure Portal."
}
},
"description": "Optional B2B user invitation configuration. When configured, instructs the replicator to create AAD B2B guest invitations for users missing in the AAD tenant managed by this meshPlatform."
},
"tenantTags": {
"required": [
"namespacePrefix",
"tagMappers"
],
"type": "object",
"properties": {
"tagMappers": {
"type": "array",
"description": "List of tag mappers for tenant tags",
"items": {
"required": [
"key",
"valuePattern"
],
"type": "object",
"properties": {
"valuePattern": {
"type": "string",
"description": "Value pattern for the tag mapper"
},
"key": {
"type": "string",
"description": "Key for the tag mapper"
}
}
}
},
"namespacePrefix": {
"type": "string",
"description": "This is the prefix for all labels created by meshStack. It helps to keep track of which labels are managed by meshStack. It is recommended to let this prefix end with a delimiter like an underscore."
}
},
"description": "Tenant tags configuration"
},
"userLookUpStrategy": {
"type": "string",
"description": "User lookup strategy ('userPrincipalName' or 'email'). Users can either be looked up in cloud platforms by email or UPN (User Principal Name). In most cases email is the matching way as it is the only identifier that is consistently used throughout all cloud platforms and meshStack."
},
"roleMappings": {
"type": "object",
"description": "Role mappings for Azure"
},
"provisioning": {
"type": "object",
"properties": {
"preProvisioned": {
"required": [
"unusedSubscriptionNamePrefix"
],
"type": "object",
"properties": {
"unusedSubscriptionNamePrefix": {
"type": "string",
"description": "The prefix that identifies unused subscriptions. Subscriptions will be renamed during meshStack's project replication, at which point they should no longer carry this prefix."
}
},
"description": "If your organization does not have access to an Enterprise Enrollment, you can alternatively configure meshcloud to consume subscriptions from a pool of externally-provisioned subscriptions. This is useful for smaller organizations that wish to use 'Pay-as-you-go' subscriptions or if you're organization partners with an Azure Cloud Solution Provider to provide your subscriptions. The meshcloud Azure replication detects externally-provisioned subscriptions based on a configurable prefix in the subscription name. Upon assignment to a meshProject, the subscription is inflated with the right Landing Zone configuration and removed from the subscription pool."
},
"customerAgreement": {
"required": [
"billingScope",
"destinationEntraId",
"sourceEntraTenant",
"sourceServicePrincipal"
],
"type": "object",
"properties": {
"sourceServicePrincipal": {
"required": [
"authType",
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The Application (Client) ID. In Azure Portal, this is the Application ID of the \"Enterprise Application\" but can also be retrieved via the \"App Registration\" object as \"Application (Client) ID\". "
},
"credentialsAuthClientSecret": {
"type": "string",
"description": "Must be set if and only if `authType` is `CREDENTIALS`. A valid secret for accessing the application. In Azure Portal, this can be configured on the \"App Registration\" under Certificates & secrets. https://docs.meshcloud.io/operations/security-faq/#how-does-meshstack-securely-handle-my-cloud-platform-credentials[How is this information secured?]",
"nullable": true
},
"authType": {
"type": "string",
"description": "Must be one of `CREDENTIALS` or `WORKLOAD_IDENTITY`. Workload Identity Federation is the one that we recommend as it enables the most secure approach to provide access to your Azure tenant without using long lived credentials. Credential Authentication is an alternative approach where you have to provide a clientSecret manually to meshStack and meshStack stores it encrypted."
}
},
"description": "Configure the SPN used by meshStack to create a new Subscription in your MCA billing scope. For more information on the required permissions, see the https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-microsoft-customer-agreement-across-tenants[Azure docs]."
},
"sourceEntraTenant": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID or domain name used for creating subscriptions. Set this to the Microsoft Entra ID Tenant owning the MCA Billing Scope. If source and destination Microsoft Entra ID Tenants are the same, you need to use UUID."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"destinationEntraId": {
"type": "string",
"description": "Microsoft Entra ID Tenant UUID where created subscriptions should be moved. Set this to the Microsoft Entra ID Tenant hosting your landing zones."
},
"billingScope": {
"type": "string",
"description": "ID of the MCA Billing Scope used for creating subscriptions. Must follow this format: `/providers/Microsoft.Billing/billingAccounts/$accountId/billingProfiles/$profileId/invoiceSections/$sectionId`."
}
},
"description": "meshcloud can automatically provision new subscriptions from a Customer Agreement Account owned by your organization. This is suitable for larger organizations that have such a Customer Agreement with Microsoft, and want to provide a large number of subscriptions in a fully automated fashion."
},
"subscriptionOwnerObjectIds": {
"type": "array",
"description": "One or more principals Object IDs (e.g. user groups, SPNs) that meshStack will ensure have an 'Owner' role assignment on the managed subscriptions. This can be useful to satisfy Azure's constraint of at least one direct 'Owner' role assignment per Subscription. If you want to use a Service Principal please use the Enterprise Application Object ID.\nYou can not use the replicator object ID here, because meshStack always removes its high privilege access after a Subscription creation.",
"nullable": true,
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"enterpriseEnrollment": {
"required": [
"enrollmentAccountId",
"subscriptionOfferType",
"useLegacySubscriptionEnrollment"
],
"type": "object",
"properties": {
"subscriptionOfferType": {
"type": "string",
"description": "The Microsoft Subscription offer type to use when creating subscriptions. Only `Production` for standard and `DevTest` for Dev/Test subscriptions are supported for the Non Legacy Subscription Enrollment. For the Legacy Subscription Enrollment also other types can be defined."
},
"enrollmentAccountId": {
"type": "string",
"description": "ID of the EA Enrollment Account used for the Subscription creation. Should look like this: `/providers/Microsoft.Billing/billingAccounts/1234567/enrollmentAccounts/7654321`. For more information, review the https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/programmatically-create-subscription-enterprise-agreement?tabs=rest-getEnrollments%2Crest-EA#find-accounts-you-have-access-to[Azure docs]."
},
"subscriptionCreationErrorCooldownSec": {
"type": "number",
"description": "This value must be defined in seconds. It is a safety mechanism to avoid duplicate Subscription creation in case of an error on Azure's MCA API. This delay should be a bit higher than it usually takes to create subscriptions. For big installations this is somewhere between 5-15 minutes. The default of 900s should be fine for most installations.",
"nullable": true
},
"useLegacySubscriptionEnrollment": {
"type": "boolean",
"description": "Deprecated: Uses the old Subscription enrollment API in its preview version. This enrollment is less reliable and should not be used for new Azure Platform Integrations."
}
},
"description": "meshcloud can automatically provision new subscriptions from an Enterprise Enrollment Account owned by your organization. This is suitable for large organizations that have a Microsoft Enterprise Agreement, Microsoft Customer Agreement or a Microsoft Partner Agreement and want to provide a large number of subscriptions in a fully automated fashion."
}
},
"description": "To provide Azure Subscription for your organization's meshProjects, meshcloud supports using Enterprise Enrollment or allocating from a pool of pre-provisioned subscriptions. One of the subFields `enterpriseEnrollment`, `customerAgreement` or `preProvisioned` must be provided!"
},
"skipUserGroupPermissionCleanup": {
"type": "boolean",
"description": "Flag to skip user group permission cleanup. For certain use cases you might want to preserve user groups and replicated permission after a tenant was deleted on the Azure platform. Checking this option preserves those permissions. Please keep in mind that the platform operator is then responsible for cleaning them up later."
},
"subscriptionNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of Azure Subscriptions managed by meshStack."
},
"groupNamePattern": {
"type": "string",
"description": "Configures the pattern that defines the desired name of AAD groups managed by meshStack. It follows the usual replicator string pattern features and provides the additional replacement 'platformGroupAlias', which contains the role name suffix, which is configurable via Role Mappings in this platform config or via a meshLandingZone. Operators must ensure the group names are unique in the managed AAD Tenant."
},
"allowHierarchicalManagementGroupAssignment": {
"type": "boolean",
"description": "Configuration flag to enable or disable hierarchical management group assignment in Azure. If set to true: Subscriptions can be moved to sub management groups of the management group defined in the Landing Zone. This is useful if you want to manage the subscription location with a deeper and more granular hierarchy. If set to false: Subscriptions will always be moved directly to the management group defined in the Landing Zone.",
"nullable": true
}
},
"description": "Replication configuration for Azure (optional, but required for replication)"
},
"entraTenant": {
"type": "string",
"description": "Azure Active Directory (Entra ID) tenant"
}
},
"description": "Configuration for Azure"
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"marketPlace",
"metering",
"platform"
],
"type": "object",
"properties": {
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"marketPlace": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Publication status in the marketplace (e.g., PUBLISHED, UNPUBLISHED, REQUESTED, REJECTED)."
}
},
"description": "Marketplace publication status information."
},
"platform": {
"type": "string",
"description": "Lifecycle state of the platform (e.g., ACTIVE, DELETED)."
}
},
"description": "Current status information of the meshPlatform."
}
}
},
"api-meshobjects-meshserviceinstances406726350": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"instanceId",
"marketplaceIdentifier",
"ownedByProject",
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The project that this Service Instance belongs to."
},
"marketplaceIdentifier": {
"type": "string",
"description": "The identifier of the marketplace that this Service Instance belongs to."
},
"instanceId": {
"type": "string",
"description": "The instance id this Service Instance should use."
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace that this Service Instance belongs to."
}
},
"description": "Metadata and more fields to identify the Service Instance."
},
"apiVersion": {
"type": "string",
"description": "Version of Service Instance datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlock' for this endpoint."
},
"spec": {
"required": [
"creator",
"displayName",
"planId",
"serviceId"
],
"type": "object",
"properties": {
"creator": {
"type": "string",
"description": "The meshUser's `username` that should be passed to the Open Service Broker via the `X-Broker-API-Originating-Identity` header."
},
"displayName": {
"type": "string",
"description": "The display name of the Service Instance."
},
"planId": {
"type": "string",
"description": "The id of the plan for this Service Instance"
},
"serviceId": {
"type": "string",
"description": "The id of the service for the Service Instance"
},
"parameters": {
"type": "object",
"description": "Parameters to pass to the Service Broker when provisioning the service instance. The structure and content of this field is defined by the service broker.",
"nullable": true
}
},
"description": "Specifications for the Service Instance."
}
}
},
"meshPlatform-List-V2": {
"title": "meshPlatform-List-V2",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Contains the self link and pagination links (first, last, next, prev)."
},
"_embedded": {
"required": [
"meshPlatforms"
],
"type": "object",
"properties": {
"meshPlatforms": {
"type": "array",
"description": "List of meshPlatforms with their configurations. Each platform object has the same structure as documented in the GET single platform response.",
"items": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"uuid"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "Timestamp when the meshPlatform was deleted, null if not deleted.",
"nullable": true
},
"name": {
"type": "string",
"description": "The platform identifier as 'name'. Be aware that the platform identifier is not unique in your meshStack. Only when you combine it with the location identifier, it can become unique ($locationIdentifier.$platformName)"
},
"uuid": {
"type": "string",
"description": "The UUID of the meshPlatform."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshPlatform."
}
},
"description": "Contains metadata to uniquely identify the meshPlatform."
},
"apiVersion": {
"type": "string",
"description": "Version of meshPlatform datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshPlatform' for this endpoint."
},
"spec": {
"required": [
"availability",
"config",
"contributingWorkspaces",
"displayName",
"locationRef",
"quotaDefinitions"
],
"type": "object",
"properties": {
"documentationUrl": {
"type": "string",
"description": "URL for platform documentation.",
"nullable": true
},
"accessInformation": {
"type": "string",
"description": "Optional access information note in Markdown format shown to platform consumers.",
"nullable": true
},
"quotaDefinitions": {
"type": "array",
"description": "List of platform quota definitions. Quota definitions define the available quotas that can be configured for tenants on this platform. Currently only supported for platform types: OPENSHIFT, KUBERNETES, AZURE_KUBERNETES_SERVICE, CLOUDFOUNDRY, OPENSTACK. For unsupported platform types (those not listed above), quota definitions have to be provided as an empty array. For supported platform types, providing an empty array will remove all existing quota definitions of the given platform.",
"items": {
"required": [
"autoApprovalThreshold",
"description",
"label",
"maxValue",
"minValue",
"quotaKey"
],
"type": "object",
"properties": {
"quotaKey": {
"type": "string",
"description": "The key of the quota as it is required by the cloud platform."
},
"minValue": {
"type": "number",
"description": "Minimum allowed value for this quota."
},
"unit": {
"type": "string",
"description": "Unit of measurement for the quota (e.g., 'cores', 'GB', 'requests'). Must match the unit expected by the cloud platform.",
"nullable": true
},
"autoApprovalThreshold": {
"type": "number",
"description": "Threshold below which quota requests are automatically approved."
},
"maxValue": {
"type": "number",
"description": "Maximum allowed value for this quota."
},
"description": {
"type": "string",
"description": "Detailed description of what this quota controls."
},
"label": {
"type": "string",
"description": "Human-readable label for the quota."
}
}
}
},
"endpoint": {
"type": "string",
"description": "The web console URL endpoint of the platform.",
"nullable": true
},
"locationRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced location, always 'meshLocation'."
},
"name": {
"type": "string",
"description": "The identifier of the location."
}
},
"description": "Reference to the location where this platform is situated."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshPlatform."
},
"supportUrl": {
"type": "string",
"description": "URL for platform support documentation.",
"nullable": true
},
"description": {
"type": "string",
"description": "description of the meshPlatform.",
"nullable": true
},
"availability": {
"required": [
"publicationState",
"restriction"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace: PUBLISHED, UNPUBLISHED, etc."
},
"restriction": {
"type": "string",
"description": "Access restriction level: PUBLIC, PRIVATE, or RESTRICTED."
},
"restrictedToWorkspaces": {
"type": "array",
"description": "If the restriction is set to RESTRICTED, you can specify the workspace identifiers this meshPlatform is restricted to.",
"nullable": true,
"items": {
"type": "string"
}
}
},
"description": "Availability configuration for the meshPlatform."
},
"readme": {
"type": "string",
"description": "README about the meshPlatform in markdown format",
"nullable": true
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"type": "object",
"description": "Kubernetes configuration, if applicable.",
"nullable": true
},
"gcp": {
"type": "object",
"description": "GCP configuration, if applicable.",
"nullable": true
},
"azurerg": {
"type": "object",
"description": "Azure Resource Group configuration, if applicable.",
"nullable": true
},
"custom": {
"type": "object",
"description": "Custom platform configuration, if applicable.",
"nullable": true
},
"openshift": {
"type": "object",
"description": "Openshift configuration, if applicable.",
"nullable": true
},
"aks": {
"type": "object",
"description": "Azure Kubernetes Service configuration, if applicable.",
"nullable": true
},
"aws": {
"type": "object",
"description": "AWS configuration, if applicable.",
"nullable": true
},
"type": {
"type": "string",
"description": "The type of platform configuration, matching the platform type of the related platform. Possible values (others are unsupported for now, but will follow): 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift', 'unsupported'."
},
"azure": {
"type": "object",
"description": "Azure configuration, if applicable.",
"nullable": true
}
},
"description": "Platform-specific configuration settings. Exactly one of its keys needs to be set."
},
"contributingWorkspaces": {
"type": "array",
"description": "A list of workspace identifiers that may contribute to this meshPlatform.",
"items": {
"type": "string"
}
}
},
"description": "All fields in this section describe the meshPlatform configuration."
},
"status": {
"required": [
"availability",
"lifecycle",
"metering"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "The timestamp when the platform was deleted. Only present if the platform has been deleted.",
"nullable": true
},
"state": {
"type": "string",
"description": "Lifecycle state of the platform. Possible values: ACTIVE, DEACTIVATED, MARKED_FOR_DELETION, DELETED."
}
},
"description": "Lifecycle state information of the platform."
},
"metering": {
"type": "string",
"description": "Metering status of the platform (e.g., PENDING, ACTIVE, FAILED)."
},
"availability": {
"required": [
"publicationState"
],
"type": "object",
"properties": {
"publicationState": {
"type": "string",
"description": "Publication status in the marketplace. Possible values: UNPUBLISHED, PUBLISHED, REQUESTED, REJECTED"
}
},
"description": "Marketplace availability and publication status information."
}
},
"description": "Current status information of the meshPlatform."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshLandingZone-Post-azure": {
"title": "meshLandingZone-Post-azure",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"name",
"ownedByWorkspace",
"tags"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier as 'name' to uniquely identify the meshLandingZone."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshLandingZone."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the workspace that owns this meshLandingZone."
}
},
"description": "Always contains the 'name' to uniquely identify the meshLandingZone."
},
"apiVersion": {
"type": "string",
"description": "Version of meshLandingZone datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on this meshObject."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshLandingZone' for this endpoint."
},
"spec": {
"required": [
"automateDeletionApproval",
"automateDeletionReplication",
"displayName",
"mandatoryBuildingBlockRefs",
"platformRef",
"quotas",
"recommendedBuildingBlockRefs"
],
"type": "object",
"properties": {
"platformProperties": {
"required": [
"type"
],
"type": "object",
"properties": {
"kubernetes": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more Kubernetes ClusterRoles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the Kubernetes Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of Kubernetes ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to Kubernetes ClusterRoles."
}
}
}
}
}
},
"azurerg": {
"required": [
"azureRgLocation",
"azureRgRoleMappings"
],
"type": "object",
"properties": {
"azureRgRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure Resource Group specific access role. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitionIds",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitionIds": {
"type": "array",
"description": "A list of Azure Role Definition IDs (e.g. 'fd876abe-603d-44d2-bf8a-067bbeacd485') that will be attached to users assigned to this role mapping within the Resource Group.",
"items": {
"type": "string"
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure Resource Group role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureRgLocation": {
"type": "string",
"description": "The newly created Resource Group for the meshProjects will get assigned to this location. It must be all lower case and without spaces (e.g. eastus2 for East US 2). In order to list the available locations you can use `az account list-locations --query \"[*].name\" --out tsv | sort`"
}
}
},
"gcp": {
"required": [
"gcpFolderId",
"gcpRoleMappings"
],
"type": "object",
"properties": {
"gcpFolderId": {
"type": "string",
"description": "Google Cloud Projects will be added to this Google Cloud Folder. This allows applying Organization Policies to all projects managed under this Landing Zone."
},
"gcpRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more GCP roles. You can use both built-in roles like 'roles/editor' or custom roles like 'organizations/123123123123/roles/meshstack.project_developer'. For more information see https://docs.meshcloud.io/meshstack.gcp.landing-zones/#meshrole-to-platform-role-mapping[the Landing Zone documentation]. Multiple GCP Roles can be assigned to one meshRole. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of GCP role identifiers assigned to users with the referenced meshProject role. Supports built-in roles (e.g. 'roles/editor') and custom roles (e.g. 'organizations/123/roles/my.role').",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to GCP roles."
}
}
}
},
"gcpTemplateUrl": {
"type": "string",
"description": "URL to a GCP bucket (starts with 'gs://') with a template config. The template is deployed in the project during the replication process. Only YAML files are supported with a file size limit of 1 MB.",
"nullable": true
},
"gcpCloudFunctionUrl": {
"type": "string",
"description": "If a GCP Cloud Function URL is provided it is getting called at the end of the replication process.",
"nullable": true
}
}
},
"custom": {
"type": "object",
"description": "Custom platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"openshift": {
"type": "object",
"description": "OpenShift platforms do not have any platform-specific properties on the landing zone level, so an empty object must be provided.",
"nullable": true
},
"aks": {
"required": [
"kubernetesRoleMappings"
],
"type": "object",
"properties": {
"kubernetesRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to one or more AKS Cluster Roles. You can use both built-in roles like 'cluster-admin' or custom ClusterRoles that you set up in the AKS Cluster. For more information see the https://docs.meshcloud.io/meshstack.kubernetes.landing-zones/[Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRoles",
"projectRoleRef"
],
"type": "object",
"properties": {
"platformRoles": {
"type": "array",
"description": "A list of AKS ClusterRole names assigned to users with the referenced meshProject role (e.g. 'cluster-admin', 'edit', 'view' or a custom ClusterRole name).",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to AKS Cluster Roles."
}
}
}
}
}
},
"type": {
"type": "string",
"description": "The platform type. Possible values are: 'aks', 'aws', 'azure', 'azurerg', 'custom', 'gcp', 'kubernetes', 'openshift'."
},
"aws": {
"required": [
"awsEnrollAccount",
"awsRoleMappings",
"awsTargetOrgUnitId"
],
"type": "object",
"properties": {
"awsTargetOrgUnitId": {
"type": "string",
"description": "The created AWS account for this Landing Zone will be put under the given Organizational Unit. You can also input a Root ID (starting with 'r-') then the account will be put directly under this root without assigning it to an OU (this is not recommended)."
},
"awsLambdaArn": {
"type": "string",
"description": "If this Lambda ARN is given, it is invoked after each project replication. You can use it to trigger a custom Account Vending Machine to perform several additional provisioning steps.",
"nullable": true
},
"awsRoleMappings": {
"type": "array",
"description": "Roles can be mapped from the meshRole to the AWS Role. The AWS role will be part of the role or group name within AWS. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"platformRole",
"policies",
"projectRoleRef"
],
"type": "object",
"properties": {
"policies": {
"type": "array",
"description": "A list of AWS policy ARNs (e.g. 'arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess') that will be attached to the AWS IAM role. Leave empty if you use external roles that are managed outside meshStack.",
"items": {
"type": "string"
}
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an AWS role."
},
"platformRole": {
"type": "string",
"description": "The AWS IAM role name that users with the referenced meshProject role will be assigned to. This role must exist in the AWS account."
}
}
}
},
"awsEnrollAccount": {
"type": "boolean",
"description": "If true, accounts will be enrolled to AWS control tower. In case an enrollment configuration is provided for the AWS platform AND this value is set to true, created AWS accounts will automatically be enrolled with AWS Control Tower. Automatic account enrollment does also require the Target Organizational Unit to already be enrolled with AWS Control Tower and the corresponding meshfed-service role needs to be in the \"IAM Principal\" list for the Portfolio access of the Account Factory Product ID you defined in platform settings. Click https://docs.meshcloud.io/integrations/aws/how-to-integrate/#8-integrate-aws-control-tower[here] to learn more about the Control Tower setup."
}
}
},
"azure": {
"required": [
"azureManagementGroupId",
"azureRoleMappings"
],
"type": "object",
"properties": {
"azureRoleMappings": {
"type": "array",
"description": "An array of mappings between the meshRole and the Azure specific access role. If empty, default role mappings defined on meshPlatform level are used. For more information see https://docs.meshcloud.io/meshstack.azure.landing-zones#meshrole-to-platform-role-mapping[the Landing Zone documentation]. If empty, the default that is configured on platform level will be used.",
"items": {
"required": [
"azureGroupSuffix",
"azureRoleDefinitions",
"projectRoleRef"
],
"type": "object",
"properties": {
"azureRoleDefinitions": {
"type": "array",
"description": "A list of Azure Role Definitions with the given IDs that will be attached to this Azure role mapping.",
"items": {
"required": [
"azureRoleDefinitionId"
],
"type": "object",
"properties": {
"abacCondition": {
"type": "string",
"description": "An optional ABAC (Attribute-Based Access Control) condition expression for the role assignment. When set, this condition restricts the scope of the role assignment.",
"nullable": true
},
"azureRoleDefinitionId": {
"type": "string",
"description": "The ID of the Azure Role Definition to attach (e.g. 'c5935d7e-37b2-4f34-af8f-bdca2408296e'). You can use `az role definition list` to find available role definition IDs."
}
}
}
},
"azureGroupSuffix": {
"type": "string",
"description": "The given role name will be injected into the group name via the group naming pattern configured on the platform instance."
},
"projectRoleRef": {
"required": [
"kind",
"name"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshProjectRole' for this ref."
},
"name": {
"type": "string",
"description": "The identifier of the meshProject role (e.g. 'admin', 'user', 'reader')."
}
},
"description": "Reference to the meshProject role that is being mapped to an Azure role."
}
}
}
},
"azureFunction": {
"required": [
"azureFunctionUrl"
],
"type": "object",
"properties": {
"azureFunctionScope": {
"type": "string",
"description": "the unique ID of the Azure Enterprise Application your function belongs to. More details are described https://docs.meshcloud.io/docs/meshstack.azure.landing-zones.html#azure-function-invocation[here].",
"nullable": true
},
"azureFunctionUrl": {
"type": "string",
"description": "The URL of your Azure Function. This is typically a value like `https://my-function-app.azurewebsites.net/myfunc`"
}
},
"description": "Assign an Azure function to the Landing Zone configuration to trigger a small piece of code in the cloud."
},
"azureManagementGroupId": {
"type": "string",
"description": "Subscriptions with this Landing Zone will be added to this Management Group. Please make sure to use the Management Group ID and not the group name!"
}
}
}
},
"description": "Custom properties for the platform of the landing zone. The values depend on the platform type. "
},
"quotas": {
"type": "array",
"description": "List of default quotas applied via this landing zone. Quotas define resource limits that will be applied to tenants using this landing zone. Tenants can afterwards request different quotas if needed. The available quota keys depend on the platform type and its quota definitions. For platforms that do not support quotas, this will be an empty array.",
"items": {
"required": [
"key",
"value"
],
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The quota value for this landing zone. Must be within the min/max range defined in the platform's quota definition."
},
"key": {
"type": "string",
"description": "The quota key as defined in the platform's quota definitions. Must match a quota definition key from the platform."
}
}
}
},
"automateDeletionApproval": {
"type": "boolean",
"description": "Whether deletion approval is automated for this landing zone."
},
"displayName": {
"type": "string",
"description": "The human-readable display name of the meshLandingZone."
},
"description": {
"type": "string",
"description": "The description of the meshLandingZone.",
"nullable": true
},
"automateDeletionReplication": {
"type": "boolean",
"description": "Whether deletion replication is automated for this landing zone."
},
"mandatoryBuildingBlockRefs": {
"type": "array",
"description": "List of mandatory building blocks that must be present when creating tenants with this landing zone. Building blocks are additional infrastructure components or configurations that enhance tenant capabilities. All mandatory building blocks will be automatically added to tenants created with this landing zone. Validation rule: If a mandatory building block has parent dependencies, all parent building blocks must also be included in the mandatory list.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition . Must refer to an existing building block definition. If a mandatory building block depends on other building blocks (parent dependencies), those parent building blocks must also be included in the mandatory list."
}
}
}
},
"recommendedBuildingBlockRefs": {
"type": "array",
"description": "List of recommended building blocks that are suggested when creating tenants with this landing zone. These building blocks are not mandatory and can be optionally selected by users during tenant creation. Validation rule: If a recommended building block has parent dependencies, all parent building blocks must be included in either the mandatory or recommended lists.",
"items": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinition' for this ref."
},
"uuid": {
"type": "string",
"description": "The UUID of the building block definition. Must refer to an existing building block definition. If a recommended building block depends on other building blocks (parent dependencies), those parent building blocks must be included in either the mandatory or recommended lists."
}
}
}
},
"platformRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshPlatform\""
},
"uuid": {
"type": "string",
"description": "The UUID of the platform instance."
}
},
"description": "Reference to the platform instance this landing zone belongs to."
},
"infoLink": {
"type": "string",
"description": "An optional link to describe more details about the landing zone",
"nullable": true
}
},
"description": "All fields in this section describe the meshLandingZone."
},
"status": {
"required": [
"lifecycle",
"restricted"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the landing zone. Possible values: ACTIVE (landing zone is active and can be used), DEACTIVATED (landing zone has been deactivated and cannot be used anymore)."
}
},
"description": "Lifecycle information of the landing zone."
},
"restricted": {
"type": "boolean",
"description": "If true, users will be unable to select this landing zone in meshPanel. Only Platform teams can create tenants using restricted landing zones with the meshObject API."
}
},
"description": "Current status of the meshLandingZone."
}
}
},
"meshApiKey-List": {
"title": "meshApiKey-List",
"required": [
"_embedded",
"_links",
"page"
],
"type": "object",
"properties": {
"_links": {
"type": "object",
"description": "Currently only contains the self link and pagination links."
},
"_embedded": {
"required": [
"meshApiKeys"
],
"type": "object",
"properties": {
"meshApiKeys": {
"type": "array",
"description": "List of meshApiKeys.",
"items": {
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"createdOn": {
"type": "string",
"description": "Timestamp when the API key was created (ISO-8601 instant format).",
"nullable": true
},
"uuid": {
"type": "string",
"description": "UUID of the API key.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "Identifier of the workspace that owns this API key."
}
},
"description": "Metadata that identifies and scopes the meshApiKey."
},
"apiVersion": {
"type": "string",
"description": "Version of meshApiKey datatype. For this endpoint this is always 'v1-preview'."
},
"_links": {
"type": "object",
"description": "Available links on a meshApiKey."
},
"kind": {
"type": "string",
"description": "The meshObject kind. For this endpoint this is always 'meshApiKey'."
},
"spec": {
"required": [
"displayName",
"permissions"
],
"type": "object",
"properties": {
"permissions": {
"type": "array",
"description": "Set of permission short-codes assigned to this API key.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"displayName": {
"type": "string",
"description": "Display name of the API key."
},
"expiresAt": {
"type": "string",
"description": "Expiration date of the API key (ISO-8601 date format, e.g. 2025-12-31). Nullable if the key does not expire.",
"nullable": true
}
},
"description": "Configuration of the meshApiKey."
},
"status": {
"required": [
"clientId"
],
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "The clientId used for authentication. Same as metadata.uuid."
},
"clientSecret": {
"type": "string",
"description": "The clientSecret used for authentication. Only included on creation (POST) or when the secret is rotated due to an expiresAt change (PUT). Omitted on GET.",
"nullable": true
}
},
"description": "Status information including clientId and the clientSecret (only on creation or key rotation)."
}
}
}
}
},
"description": "Contains the actual content of the paged response."
},
"page": {
"type": "object",
"description": "Information about paging."
}
}
},
"meshBuildingBlockRunCreate": {
"title": "meshBuildingBlockRunCreate",
"required": [
"_links",
"apiVersion",
"kind",
"spec",
"status"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID of this building block run."
}
}
},
"apiVersion": {
"type": "string",
"description": "Version of meshBuildingBlockRun datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshBuildingBlockRun."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockRun' for this endpoint."
},
"spec": {
"required": [
"behavior",
"runNumber",
"runToken"
],
"type": "object",
"properties": {
"buildingBlock": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID of the referenced building block."
},
"spec": {
"required": [
"displayName",
"fullPlatformIdentifier",
"inputs",
"parentBuildingBlocks",
"projectIdentifier",
"workspaceIdentifier"
],
"type": "object",
"properties": {
"parentBuildingBlocks": {
"type": "array",
"description": "A list of parent building blocks UUIDs for this building block.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"fullPlatformIdentifier": {
"type": "string",
"description": "The full identifier of the platform of the building block."
},
"inputs": {
"type": "array",
"description": "Contains the filled in input objects for this building block run.",
"items": {
"required": [
"isEnvironment",
"isSensitive",
"key",
"type",
"value"
],
"type": "object",
"properties": {
"isSensitive": {
"type": "boolean",
"description": "Flag if the variable content is sensitive and encrypted. The runner must decrypt this variable content first before it can be used."
},
"isEnvironment": {
"type": "boolean",
"description": "Flag if this variable should be provided as environment variable instead of getting handled as a 'native' variable for the chosen runner technology (for example a Terraform input)."
},
"type": {
"type": "string",
"description": "The type of the variable. One of STRING, CODE, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT, MULTI_SELECT."
},
"value": {
"type": "string",
"description": "The value of this variable."
},
"key": {
"type": "string",
"description": "The name of the input variable."
}
}
}
},
"displayName": {
"type": "string",
"description": "Display name of the building block."
},
"workspaceIdentifier": {
"type": "string",
"description": "The identifier of the workspace of the building block."
},
"projectIdentifier": {
"type": "string",
"description": "The identifier of the project of the building block."
}
}
}
}
},
"runToken": {
"type": "string",
"description": "JWT token that can be used by the runner to authenticate when calling back to meshStack to report status updates for this run. This token is scoped the the building block definition owner so it can only be used to update the run related steps/status or source registrations."
},
"buildingBlockDefinition": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID of the building block definition."
},
"spec": {
"required": [
"implementation",
"version",
"workspaceIdentifier"
],
"type": "object",
"properties": {
"implementation": {
"type": "object",
"description": "Contains information about the used implementation e.g. Terraform specific details of the building block."
},
"workspaceIdentifier": {
"type": "string",
"description": "The identifier of the workspace that owns the building block definition."
},
"version": {
"type": "number",
"description": "Version of the building block definition."
}
}
}
}
},
"runNumber": {
"type": "number",
"description": "Every run has a monotonically increasing number."
},
"behavior": {
"type": "string",
"description": "The behavior the runner should execute. One of APPLY, DETECT, DESTROY."
}
},
"description": "All fields in this section describe the meshBuildingBlockRun."
},
"status": {
"type": "string",
"description": "The current execution status of this building block run."
}
}
},
"api-meshobjects-meshintegrations-168845288": {
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"ownedByWorkspace": {
"type": "string",
"description": "The workspace identifier that owns this integration."
}
},
"description": "Contains identifiers and ownership information for the integration."
},
"apiVersion": {
"type": "string",
"description": "Version of meshIntegration datatype. Matches the version part provided within the `Accept` request header."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshIntegration' for this endpoint."
},
"spec": {
"required": [
"config",
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the integration."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"github": {
"required": [
"appId",
"appPrivateKey",
"baseUrl",
"owner",
"runnerRef"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The GitHub organization or user that owns the repositories."
},
"baseUrl": {
"type": "string",
"description": "The base URL of the GitHub API. Use 'https://api.github.com' for GitHub.com or your GitHub Enterprise URL."
},
"appPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The GitHub App private key for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"appId": {
"type": "string",
"description": "The GitHub App ID for authentication."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitHub-specific integration configuration."
},
"entraid": {
"required": [
"clientId",
"clientSecret",
"tenantId"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "The redirect URL to configure in the Entra Id app registration. This field is read-only and computed by the system.",
"nullable": true
},
"clientId": {
"type": "string",
"description": "The application (client) Id registered in the Entra Id tenant."
},
"tenantId": {
"type": "string",
"description": "The Microsoft Entra Id (Azure AD) tenant Id."
},
"clientSecret": {
"type": "object",
"description": "The client secret for authenticating with the Entra Id application. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Entra Id-specific integration configuration."
},
"azuredevops": {
"required": [
"baseUrl",
"organization",
"personalAccessToken",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the Azure DevOps instance. Typically 'https://dev.azure.com' for Azure DevOps Services."
},
"organization": {
"type": "string",
"description": "The Azure DevOps organization name."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
},
"personalAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Personal Access Token (PAT) for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Azure DevOps-specific integration configuration."
},
"gitlab": {
"required": [
"baseUrl",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the GitLab instance. Use 'https://gitlab.com' for GitLab.com or your self-hosted GitLab URL."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitLab-specific integration configuration."
},
"type": {
"type": "string",
"description": "The type of integration. Available types are: 'azuredevops','entraid','github','gitlab','metering','replicator'. EntraId integrations are only available for the admin workspace."
}
},
"description": "Integration configuration. Contains a 'type' field that determines the integration type ('azuredevops','entraid','github','gitlab','metering','replicator') and type-specific properties nested under the corresponding key (e.g., 'github', 'gitlab', 'azuredevops')."
}
},
"description": "All fields in this section describe the integration configuration."
}
}
},
"meshIntegration-Get-builtin-metering": {
"title": "meshIntegration-Get-builtin-metering",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID that uniquely identifies the integration across all integrations.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The workspace identifier that owns this integration."
}
},
"description": "Contains identifiers and ownership information for the integration."
},
"apiVersion": {
"type": "string",
"description": "Version of meshIntegration datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshIntegration."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshIntegration' for this endpoint."
},
"spec": {
"required": [
"config",
"displayName"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the integration."
},
"config": {
"required": [
"type"
],
"type": "object",
"properties": {
"github": {
"required": [
"appId",
"appPrivateKey",
"baseUrl",
"owner",
"runnerRef"
],
"type": "object",
"properties": {
"owner": {
"type": "string",
"description": "The GitHub organization or user that owns the repositories."
},
"baseUrl": {
"type": "string",
"description": "The base URL of the GitHub API. Use 'https://api.github.com' for GitHub.com or your GitHub Enterprise URL."
},
"appPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The GitHub App private key for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"appId": {
"type": "string",
"description": "The GitHub App ID for authentication."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitHub-specific integration configuration."
},
"entraid": {
"required": [
"clientId",
"clientSecret",
"tenantId"
],
"type": "object",
"properties": {
"redirectUrl": {
"type": "string",
"description": "The redirect URL to configure in the Entra Id app registration. This field is read-only and computed by the system.",
"nullable": true
},
"clientId": {
"type": "string",
"description": "The application (client) Id registered in the Entra Id tenant."
},
"tenantId": {
"type": "string",
"description": "The Microsoft Entra Id (Azure AD) tenant Id."
},
"clientSecret": {
"type": "object",
"description": "The client secret for authenticating with the Entra Id application. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Entra Id-specific integration configuration."
},
"azuredevops": {
"required": [
"baseUrl",
"organization",
"personalAccessToken",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the Azure DevOps instance. Typically 'https://dev.azure.com' for Azure DevOps Services."
},
"organization": {
"type": "string",
"description": "The Azure DevOps organization name."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
},
"personalAccessToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The Personal Access Token (PAT) for authentication. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
}
},
"description": "Azure DevOps-specific integration configuration."
},
"gitlab": {
"required": [
"baseUrl",
"runnerRef"
],
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the GitLab instance. Use 'https://gitlab.com' for GitLab.com or your self-hosted GitLab URL."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "This is a fixed value \"meshBuildingBlockRunner\"."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "Reference to the Building Block Runner that will execute building blocks using this integration."
}
},
"description": "GitLab-specific integration configuration."
},
"type": {
"type": "string",
"description": "The type of integration. Available types are: 'azuredevops','entraid','github','gitlab','metering','replicator'. EntraId integrations are only available for the admin workspace."
}
},
"description": "Integration configuration. Contains a 'type' field that determines the integration type ('azuredevops','entraid','github','gitlab','metering','replicator') and type-specific properties nested under the corresponding key (e.g., 'github', 'gitlab', 'azuredevops')."
}
},
"description": "All fields in this section describe the integration configuration."
},
"status": {
"required": [
"isBuiltIn",
"lifecycle"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"state"
],
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The current lifecycle state of the integration. For meshIntegration, only ACTIVE is supported."
},
"createdOn": {
"type": "string",
"description": "Timestamp when the integration was created. This field is automatically set by the system and cannot be modified.",
"nullable": true
}
},
"description": "Lifecycle information of the integration."
},
"workloadIdentityFederation": {
"required": [
"issuer",
"subject"
],
"type": "object",
"properties": {
"gcp": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "GCP Workload Identity Pool audience for token exchange."
}
},
"description": "Google Cloud Platform specific WIF configuration."
},
"subject": {
"type": "string",
"description": "OIDC subject claim for Workload Identity Federation. Identifies the workload service account."
},
"aws": {
"required": [
"audience",
"thumbprint"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "AWS STS audience for AssumeRoleWithWebIdentity."
},
"thumbprint": {
"type": "string",
"description": "AWS OIDC provider thumbprint for trust verification."
}
},
"description": "Amazon Web Services specific WIF configuration."
},
"issuer": {
"type": "string",
"description": "OIDC issuer URL for Workload Identity Federation."
},
"azure": {
"required": [
"audience"
],
"type": "object",
"properties": {
"audience": {
"type": "string",
"description": "Azure AD audience for workload identity federation."
}
},
"description": "Microsoft Azure specific WIF configuration."
}
},
"description": "Workload Identity Federation (WIF) configuration for this integration. Only present for built-in integrations. Provides OIDC issuer, subject, and cloud provider-specific configuration needed to set up trust relationships for workload identity."
},
"isBuiltIn": {
"type": "boolean",
"description": "Indicates whether this integration is a built-in system integration."
}
},
"description": "Status information for integrations. Always includes the isBuiltIn field in responses. Workload Identity Federation (WIF) information is only present for built-in integrations. This field is read-only and ignored in request bodies."
}
}
},
"meshBuildingBlockDefinitionVersion-post-V1-terraform": {
"title": "meshBuildingBlockDefinitionVersion-post-V1-terraform",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"ownedByWorkspace"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID to uniquely identify the Building Block Definition Version.",
"nullable": true
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the Building Blocks Definition Version belongs to."
}
},
"description": "Always contains the 'uuid' to uniquely identify the Building Block Definition Version. It also contains additional meta information like the version creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of Building Block Definition Version datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a Building Block Definition Version."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshBuildingBlockDefinitionVersion' for this endpoint."
},
"spec": {
"required": [
"buildingBlockDefinitionRef",
"deletionMode",
"implementation",
"inputs",
"onlyApplyOncePerTenant",
"outputs",
"runnerRef",
"state",
"versionNumber"
],
"type": "object",
"properties": {
"outputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"type"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "Human-readable display name for the output."
},
"type": {
"type": "string",
"description": "Data type of the output (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE'])."
},
"assignmentType": {
"type": "string",
"description": "How the output is used (One of ['NONE', 'PLATFORM_TENANT_ID', 'SIGN_IN_URL', 'RESOURCE_URL', 'SUMMARY'])."
}
}
}
},
"description": "Map of output definitions for this Building Block Definition Version. The map's keys are output keys, the values are output definition objects. For manual Building Block Definitions, there must not be any outputs that do not match an input with the same key. For manual Building Block Definitions, the type of outputs must match the one from the input with the same key, but must be translated from SINGLE_SELECT to STRING and from MULTI_SELECT to CODE. "
},
"inputs": {
"type": "object",
"properties": {
"*": {
"required": [
"assignmentType",
"displayName",
"isEnvironment",
"isSensitive",
"type",
"updateableByConsumer"
],
"type": "object",
"properties": {
"argument": {
"type": "object",
"description": "Argument value for the input. Required if assignment type is 'STATIC'\nor 'BUILDING_BLOCK_OUTPUT'.\nFor 'BUILDING_BLOCK_OUTPUT', the value must be a string in the\nformat `.` referencing an output of a parent building block.\nMust match the input type if provided. If input type is 'CODE',\nthe value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of\n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"valueValidationRegex": {
"type": "string",
"description": "Regular expression pattern to validate input values. (optional)",
"nullable": true
},
"defaultValue": {
"type": "object",
"description": "Default value for the input (optional). Must match the input type if provided.\nIf input type is 'CODE', the value must be provided as a string.\nIf you intend to provide a JSON value, it must be an escaped JSON string, e.g. instead of \n`{\"foo\": \"bar\"}` use `{\\\"foo\\\":\\\"bar\\\"}`.",
"nullable": true
},
"isSensitive": {
"type": "boolean",
"description": "Whether this input contains sensitive data that should be encrypted."
},
"displayName": {
"type": "string",
"description": "Human-readable display name for the input."
},
"description": {
"type": "string",
"description": "Description explaining the purpose and usage of the input. (optional)",
"nullable": true
},
"selectableValues": {
"type": "array",
"description": "Set of allowed values for the input in case the type is one of 'SINGLE_SELECT' or 'MULTI_SELECT'. (Must be either null or an empty array.)",
"nullable": true,
"items": {
"type": "string"
}
},
"validationRegexErrorMessage": {
"type": "string",
"description": "Error message to display when regex validation fails. (optional)",
"nullable": true
},
"isEnvironment": {
"type": "boolean",
"description": "Whether this input is exposed as a regular or environment variable."
},
"type": {
"type": "string",
"description": "Data type of the input (One of ['STRING', 'CODE', 'INTEGER', 'BOOLEAN', 'FILE', 'SINGLE_SELECT', 'MULTI_SELECT'])."
},
"updateableByConsumer": {
"type": "boolean",
"description": "Whether the input value can be updated by the consumer that does not have admin or platform operator permissions."
},
"assignmentType": {
"type": "string",
"description": "How the input value is assigned (One of ['AUTHOR', 'USER_INPUT', 'PLATFORM_OPERATOR_MANUAL_INPUT', 'BUILDING_BLOCK_OUTPUT', 'PLATFORM_TENANT_ID', 'WORKSPACE_IDENTIFIER', 'PROJECT_IDENTIFIER', 'FULL_PLATFORM_IDENTIFIER', 'TENANT_BUILDING_BLOCK_UUID', 'STATIC', 'USER_PERMISSIONS'])."
}
}
}
},
"description": "Map of input definitions for this Building Block Definition Version. The map's keys are input keys, the values are input definition objects."
},
"permissions": {
"type": "array",
"description": "List of [permission short codes](/api/authentication/api-permissions) that the [ephemeral API key](/concepts/building-block/#ephemeral-api-keys) of a Building Block using this version will receive. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"implementation": {
"required": [
"azureDevOpsPipeline",
"githubWorkflows",
"gitlabPipeline",
"terraform",
"type"
],
"type": "object",
"properties": {
"azureDevOpsPipeline": {
"required": [
"async",
"integrationRef",
"pipelineId",
"project"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"project": {
"type": "string",
"description": "The Azure DevOps project containing the pipeline."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced Azure DevOps integration."
}
},
"description": "The reference to the meshIntegration for this Azure DevOps implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use for the Azure DevOps pipeline run.",
"nullable": true
},
"pipelineId": {
"type": "string",
"description": "The ID of the Azure DevOps pipeline to run."
}
},
"description": "Azure DevOps Pipeline Implementation details for this version."
},
"gitlabPipeline": {
"required": [
"integrationRef",
"pipelineTriggerToken",
"projectId",
"refName"
],
"type": "object",
"properties": {
"pipelineTriggerToken": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "The pipeline trigger token used to trigger the GitLab pipeline. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitLab integration."
}
},
"description": "The reference to the meshIntegration for this GitLab implementation."
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use."
},
"projectId": {
"type": "string",
"description": "The GitLab project ID containing the pipeline."
}
},
"description": "GitLab Pipeline Implementation details for this version."
},
"terraform": {
"required": [
"async",
"repositoryUrl",
"sshPrivateKey",
"terraformVersion"
],
"type": "object",
"properties": {
"useMeshHttpBackendFallback": {
"type": "boolean",
"description": "Whether to use the Mesh HTTP backend for state storage.",
"nullable": true
},
"terraformVersion": {
"type": "string",
"description": "The version of Terraform / OpenTofu to use."
},
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"sshKnownHost": {
"required": [
"host",
"keyType",
"keyValue"
],
"type": "object",
"properties": {
"keyValue": {
"type": "string",
"description": "The SSH public key value of the Git server."
},
"host": {
"type": "string",
"description": "The hostname of the Git server."
},
"keyType": {
"type": "string",
"description": "The type of the SSH key (e.g., ssh-rsa, ssh-ed25519)."
}
},
"description": "The known host configuration for SSH access to the Git repository."
},
"sshPrivateKey": {
"type": "object",
"properties": {
"plaintext": {
"type": "string",
"description": "The plaintext secret value. Required for POST, optional for PUT (to update the secret). Never returned in responses.",
"nullable": true
},
"hash": {
"type": "string",
"description": "SHA-256 hash of the encrypted secret. Always returned in GET responses. It can be provided in PUT requests to keep the existing secret unchanged. If the hash doesn't match the stored value, a 409 Conflict error is returned (drift detection).",
"nullable": true
}
},
"description": "SSH private key used to access the Git repository. This is represented as a Secret object containing either the secret value or the hash, depending on the request/response context."
},
"preRunScript": {
"type": "string",
"description": "An optional shell script (max 16 KiB) executed before each Terraform / OpenTofu run inside the runner container. Use this to perform setup tasks such as installing dependencies or configuring credentials.",
"nullable": true
},
"repositoryPath": {
"type": "string",
"description": "The path within the Git repository to the Terraform / OpenTofu configuration.",
"nullable": true
},
"refName": {
"type": "string",
"description": "The Git reference name (branch, tag, or commit) to use.",
"nullable": true
},
"repositoryUrl": {
"type": "string",
"description": "The URL of the Git repository containing the Terraform / OpenTofu configuration."
}
},
"description": "Terraform / OpenTofu Implementation details for this version."
},
"githubWorkflows": {
"required": [
"applyWorkflow",
"async",
"branch",
"integrationRef",
"omitRunObjectInput",
"repository"
],
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "Whether to use asynchronous runs for this building block."
},
"destroyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to destroy the building block.",
"nullable": true
},
"integrationRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Always 'meshIntegration'."
},
"uuid": {
"type": "string",
"description": "The UUID of the referenced GitHub integration."
}
},
"description": "The reference to the meshIntegration for this GitHub implementation."
},
"applyWorkflow": {
"type": "string",
"description": "The filename of the GitHub Actions workflow to apply the building block."
},
"repository": {
"type": "string",
"description": "The GitHub repository containing the workflows."
},
"branch": {
"type": "string",
"description": "The branch of the GitHub repository to use."
},
"omitRunObjectInput": {
"type": "boolean",
"description": "Whether to omit the run object input when triggering the workflow."
}
},
"description": "GitHub Workflows Implementation details for this version."
},
"type": {
"type": "string",
"description": "The type of implementation (, , , , , , , , , )."
}
},
"description": "The implementation details of the Building Block Definition Version. The structure of this field depends on the implementation type."
},
"runnerRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockRunner')."
},
"uuid": {
"type": "string",
"description": "The UUID of the Building Block Runner."
}
},
"description": "Reference to the Building Block Runner that executes this version."
},
"buildingBlockDefinitionRef": {
"required": [
"kind",
"uuid"
],
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "The kind of the referenced object (always 'meshBuildingBlockDefinition')."
},
"uuid": {
"type": "string",
"description": "The UUID of the parent Building Block Definition."
}
},
"description": "Reference to the parent Building Block Definition."
},
"onlyApplyOncePerTenant": {
"type": "boolean",
"description": "Whether this building block can only be applied once per tenant. This is not relevant for Building Blocks on Workspace level."
},
"state": {
"type": "string",
"description": "The state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"dependencyDefinitionUuids": {
"type": "array",
"description": "List of Building Block Definition UUIDs that this version depends on. Defaults to an empty list, if omitted.",
"nullable": true,
"items": {
"type": "string"
}
},
"deletionMode": {
"type": "string",
"description": "Specifies how deletion of building blocks based on this version is handled. (One of ['DELETE', 'PURGE'])"
},
"versionNumber": {
"type": "number",
"description": "The version number of this Building Block Definition Version."
}
},
"description": "All fields in this section describe the Building Block Definition Version."
},
"status": {
"required": [
"lifecycle",
"state",
"usageCount"
],
"type": "object",
"properties": {
"lifecycle": {
"required": [
"createdOn",
"state"
],
"type": "object",
"properties": {
"markedForDeletionOn": {
"type": "string",
"description": "The Building Block Definition Version has been marked for deletion at this date (e.g. `2020-12-22T09:37:43Z`). This field is only present if the parent definition is marked for deletion.",
"nullable": true
},
"markedForDeletionBy": {
"type": "string",
"description": "If the parent Building Block Definition has been marked for deletion, the username of the user who triggered the deletion is provided here.",
"nullable": true
},
"state": {
"type": "string",
"description": "The lifecycle state of the version. (One of ['ACTIVE', 'DEACTIVATED', 'MARKED_FOR_DELETION', 'DELETED'])"
},
"createdOn": {
"type": "string",
"description": "The Building Block Definition Version has been created at this date (e.g. `2020-12-22T09:37:43Z`)."
}
},
"description": "Lifecycle information including creation and deletion timestamps."
},
"state": {
"type": "string",
"description": "The current state of the version. (One of ['DRAFT', 'RELEASED'])"
},
"usageCount": {
"type": "number",
"description": "The number of building blocks currently using this version."
}
},
"description": "All fields in this section describe the current status of the Building Block Definition Version."
}
}
},
"meshTenantPostV3": {
"title": "meshTenantPostV3",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"assignedTags",
"ownedByProject",
"ownedByWorkspace",
"platformIdentifier",
"tenantIdentifier"
],
"type": "object",
"properties": {
"ownedByProject": {
"type": "string",
"description": "The identifier of the meshProject the meshTenant belongs to."
},
"assignedTags": {
"type": "object",
"description": "The tags assigned to this meshTenant originating from meshWorkspace, Payment Method and meshProject. Keep in mind, that values are an array."
},
"deletedOn": {
"type": "string",
"description": "If the meshTenant has been submitted for deletion by a Workspace Manager, the date, the date is represented here (e.g. `2020-12-22T09:37:43Z)`. Otherwise this field is missing.",
"nullable": true
},
"platformIdentifier": {
"type": "string",
"description": "The identifier of the related platform instance"
},
"tenantIdentifier": {
"type": "string",
"description": "The full identifier of this tenant is a unique string consisting of the workspace identifier, project identifier and platform identifier separated by '.'."
},
"ownedByWorkspace": {
"type": "string",
"description": "The identifier of the meshWorkspace the meshTenant belongs to."
}
},
"description": "Always contains the 'ownedByProject', 'ownedByWorkspace' and 'platformIdentifier' to identify the meshTenant."
},
"apiVersion": {
"type": "string",
"description": "Version of meshTenant datatype. Matches the version provided in the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Currently only contains the self link."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshTenant' for this endpoint."
},
"spec": {
"required": [
"landingZoneIdentifier",
"quotas"
],
"type": "object",
"properties": {
"quotas": {
"type": "array",
"description": "The set of applied Tenant Quotas. They can be set individually per tenant. By default the Landing Zone quotas are applied to new meshTenants.",
"items": {
"oneOf": [
{
"type": "object"
},
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"landingZoneIdentifier": {
"type": "string",
"description": "The identifier of the Landing Zone of this meshTenant. This field will be empty if the meshTenant has no Landing Zone."
},
"localId": {
"type": "string",
"description": "The localId (platform tenant id) assigned by the platform for this meshTenant. It will only be set if the tenant was either imported via meshObject API with a localId or if at least one replication run finished successfully for this tenant.",
"nullable": true
}
},
"description": "All fields in this section describe the meshTenant."
}
}
},
"meshWorkspace": {
"title": "meshWorkspace",
"required": [
"_links",
"apiVersion",
"kind",
"metadata",
"spec"
],
"type": "object",
"properties": {
"metadata": {
"required": [
"createdOn",
"name",
"tags"
],
"type": "object",
"properties": {
"deletedOn": {
"type": "string",
"description": "If the meshWorkspace has already been deleted, the date when deletion happened is provided via this field. e.g. `2020-12-22T09:37:43Z` (readonly)",
"nullable": true
},
"name": {
"type": "string",
"description": "The workspaceIdentifier as 'name' to uniquely identify the meshWorkspace. (readonly after creation)"
},
"createdOn": {
"type": "string",
"description": "The meshWorkspace has been created at this date (e.g. `2020-12-22T09:37:43Z`, readonly)."
},
"tags": {
"type": "object",
"description": "Key/Value pairs of tags set on the meshWorkspace. Keep in mind, that values are an array. You must always provide all the tags of the workspace inside this object. If you provide an empty object, the tags will be removed from your workspace."
}
},
"description": "Always contains the 'name' to uniquely identify the meshWorkspace. Can additionally contain meta information like the meshWorkspace creation date."
},
"apiVersion": {
"type": "string",
"description": "Version of meshWorkspace datatype. Matches the version part provided within the `Accept` request header."
},
"_links": {
"type": "object",
"description": "Available links on a meshWorkspace."
},
"kind": {
"type": "string",
"description": "As a common meshObject structure exists, every meshObject has a 'kind'. This is always 'meshWorkspace' for this endpoint."
},
"spec": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"platformBuilderAccessEnabled": {
"type": "boolean",
"description": "When enabled, you can open the platform builder at the top right of your screen when you visit the workspace in the panel.",
"nullable": true
},
"displayName": {
"type": "string",
"description": "The display name of the meshWorkspace as it is shown in meshPanel."
}
},
"description": "All fields in this section describe the meshWorkspace."
}
}
}
},
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "",
"tokenUrl": "",
"scopes": {
}
}
}
},
"basic": {
"type": "http",
"scheme": "basic"
}
}
}
}