Query the Developer Portal from Claude, Codex, Cursor, or VS Code!
Connect with MCP
Ctrlk
Collibra sitesRequest a demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Jobserver Configuration

Get Jobserver's Monitoring JVM configuration. Requires super role.

get
Path parameters
managedServiceIdstring · uuidRequired
Responses
200

successful operation

No content
get/spark/configuration/contextJvm/{managedServiceId}
GET /rest/spark/configuration/contextJvm/{managedServiceId} HTTP/1.1
Accept: */*
200

successful operation

No content

Overwrite Jobserver's Monitoring JVM configuration. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Body
jvmParametersstring[]Optional
Responses
200

successful operation

No content
post/spark/configuration/contextJvm/{managedServiceId}
POST /rest/spark/configuration/contextJvm/{managedServiceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "jvmParameters": [
    "text"
  ]
}
200

successful operation

No content

Update Jobserver's Monitoring JVM configuration with JSON. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Body
stringOptional
Responses
200

successful operation

No content
post/spark/configuration/contextJvm/{managedServiceId}/json
POST /rest/spark/configuration/contextJvm/{managedServiceId}/json HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
200

successful operation

No content

Restore Jobserver's Monitoring JVM configuration to default. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Responses
200

successful operation

No content
post/spark/configuration/contextJvm/{managedServiceId}/restoreDefaults
POST /rest/spark/configuration/contextJvm/{managedServiceId}/restoreDefaults HTTP/1.1
Accept: */*
200

successful operation

No content

Get Jobserver's JVM configuration. Requires super role.

get
Path parameters
managedServiceIdstring · uuidRequired
Responses
200

successful operation

No content
get/spark/configuration/jvm/{managedServiceId}
GET /rest/spark/configuration/jvm/{managedServiceId} HTTP/1.1
Accept: */*
200

successful operation

No content

Overwrite Jobserver's JVM configuration. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Body
jvmParametersstring[]Optional
Responses
200

successful operation

No content
post/spark/configuration/jvm/{managedServiceId}
POST /rest/spark/configuration/jvm/{managedServiceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "jvmParameters": [
    "text"
  ]
}
200

successful operation

No content

Update Jobserver's JVM configuration with JSON. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Body
stringOptional
Responses
200

successful operation

No content
post/spark/configuration/jvm/{managedServiceId}/json
POST /rest/spark/configuration/jvm/{managedServiceId}/json HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
200

successful operation

No content

Restore Jobserver's JVM configuration to default. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Responses
200

successful operation

No content
post/spark/configuration/jvm/{managedServiceId}/restoreDefaults
POST /rest/spark/configuration/jvm/{managedServiceId}/restoreDefaults HTTP/1.1
Accept: */*
200

successful operation

No content

Get Jobserver's Server configuration definition.

get
Responses
200

successful operation

No content
get/spark/configuration/server/definition
GET /rest/spark/configuration/server/definition HTTP/1.1
Accept: */*
200

successful operation

No content

Get Jobserver's Server configuration.

get
Path parameters
managedServiceIdstring · uuidRequired
Responses
200

successful operation

No content
get/spark/configuration/server/{managedServiceId}
GET /rest/spark/configuration/server/{managedServiceId} HTTP/1.1
Accept: */*
200

successful operation

No content

Overwrite Jobserver's JVM configuration. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Body
jobserverMemorystringRequired
jobserverMonitoringPortinteger · int32 · max: 65535Required
portinteger · int32 · max: 65535Required
sparkMemorystringRequired
sparkMonitoringPortinteger · int32 · max: 65535Required
Responses
200

successful operation

No content
post/spark/configuration/server/{managedServiceId}
POST /rest/spark/configuration/server/{managedServiceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "jobserverMemory": "text",
  "jobserverMonitoringPort": 1,
  "jobserverSecurityConfiguration": {
    "authentication": "NONE",
    "certificateChain": "text",
    "privateKey": "text",
    "trustedCertificate": "text"
  },
  "port": 1,
  "sparkMemory": "text",
  "sparkMonitoringPort": 1
}
200

successful operation

No content

Update Jobserver's JVM configuration with JSON. Requires super role.

post
Path parameters
managedServiceIdstring · uuidRequired
Body
stringOptional
Responses
200

successful operation

No content
post/spark/configuration/server/{managedServiceId}/json
POST /rest/spark/configuration/server/{managedServiceId}/json HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
200

successful operation

No content

Get Jobserver's Server configuration.

post
Path parameters
managedServiceIdstring · uuidRequired
Responses
200

successful operation

No content
post/spark/configuration/server/{managedServiceId}/restoreDefaults
POST /rest/spark/configuration/server/{managedServiceId}/restoreDefaults HTTP/1.1
Accept: */*
200

successful operation

No content
PreviousService Provider
NextSupport

Last updated

Was this helpful?