GRgravitee-io
Data Planes

Create or update a data plane

Changed on

Idempotent create-or-update. Uses the id field in the body to identify the data plane within the environment. The type is immutable, and the organization and environment come from the path. An id: reference updates a data plane the Automation API does not manage, and cannot create one.

put/organizations/{orgId}/environments/{envId}/dataplanes

Request

  • Base URL
    http://localhost:8093/automation
  • URL
    http://localhost:8093/automation/organizations/{orgId}/environments/{envId}/dataplanes
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Identifier of the organization that owns the environment.

envIdstring required

Identifier of the environment the resource belongs to.

Request body

configurationobject

Connection settings. Write-only: it can hold credentials.

createdAtstring date-time

Creation timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

databasestring

Name of the database the configuration points at. Read-only.

environmentIdstring

Identifier of the environment the data plane belongs to. Read-only.

gatewayUrlstring

Base URL of the gateway serving the domains bound to this data plane. Must be an absolute http(s) URL with a lowercase scheme; omitted or empty leaves it unset.

hostsstring[]

Hosts the configuration points at, as host:port. Read-only.

idstring required

Stable, immutable identifier for the data plane within its environment. Lowercase alphanumeric and hyphens, starting and ending with an alphanumeric character. This is the value a domain's dataPlaneId refers to.

namestring

Human-readable name of the data plane.

organizationIdstring

Identifier of the organization the data plane belongs to. Read-only.

typestring

Data plane plugin type identifier, matching the dataplane-am-<type> plugin. Immutable after creation.

updatedAtstring date-time

Last-update timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

Example request

{
  "configuration": {
    "mongodb": {
      "dbname": "gravitee-am-acme",
      "host": "mongo",
      "port": 27017
    }
  },
  "database": "gravitee-am-acme",
  "environmentId": "DEFAULT",
  "gatewayUrl": "https://gateway-eu.example.com",
  "hosts": [
    "mongo:27017"
  ],
  "id": "acme-eu",
  "name": "ACME EU data plane",
  "organizationId": "DEFAULT",
  "type": "mongodb"
}

Response

The created or updated data plane

configurationobject

Connection settings. Write-only: it can hold credentials.

createdAtstring date-time

Creation timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

databasestring

Name of the database the configuration points at. Read-only.

environmentIdstring

Identifier of the environment the data plane belongs to. Read-only.

gatewayUrlstring

Base URL of the gateway serving the domains bound to this data plane. Must be an absolute http(s) URL with a lowercase scheme; omitted or empty leaves it unset.

hostsstring[]

Hosts the configuration points at, as host:port. Read-only.

idstring required

Stable, immutable identifier for the data plane within its environment. Lowercase alphanumeric and hyphens, starting and ending with an alphanumeric character. This is the value a domain's dataPlaneId refers to.

namestring

Human-readable name of the data plane.

organizationIdstring

Identifier of the organization the data plane belongs to. Read-only.

typestring

Data plane plugin type identifier, matching the dataplane-am-<type> plugin. Immutable after creation.

updatedAtstring date-time

Last-update timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

Example response

{
  "configuration": {
    "mongodb": {
      "dbname": "gravitee-am-acme",
      "host": "mongo",
      "port": 27017
    }
  },
  "database": "gravitee-am-acme",
  "environmentId": "DEFAULT",
  "gatewayUrl": "https://gateway-eu.example.com",
  "hosts": [
    "mongo:27017"
  ],
  "id": "acme-eu",
  "name": "ACME EU data plane",
  "organizationId": "DEFAULT",
  "type": "mongodb"
}

Changes