Sign in
v1
Instance Configuration

Set Organization Instance Config

Set default dedicated instance configuration for the organization (inherited by namespaces without their own config).

put/v1/organization/instance

Query parameters

validateboolean

Test connection before saving

Test connection before saving

Headers

X-API-Keystring required

Request body

providerstring

Cloud provider (only 'gcp' supported today)

regionstring

Cloud region (only 'us-west1' supported today)

Example request

{
  "neo4j": {
    "bolt_url": "neo4j+s://abc12345.databases.neo4j.io",
    "graphql_endpoint": "https://abc12345-graphql.production-orch-0042.neo4j.io/graphql",
    "password": "my-secret-password",
    "username": "neo4j"
  },
  "provider": "gcp",
  "region": "us-west1"
}

Response

Successful Response

codeinteger

HTTP status code

statusstring

'success' or 'error'

errorstring nullable

Error message if failed

{"stackTrail":"components:schemas:InstanceConfigResponse:properties:details:anyOf","oasType":"schema","type":"unknown","title":"Details","description":"Additional context","nullable":true}

Changes

Changed in 1 of the 37 revisions of this API.1