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}

HTTPcURLJavaScriptPython

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

application/json

jvmParametersstring[]Optional

Responses

200

successful operation

No content

post/spark/configuration/contextJvm/{managedServiceId}

HTTPcURLJavaScriptPython

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

application/json

stringOptional

Responses

200

successful operation

No content

post/spark/configuration/contextJvm/{managedServiceId}/json

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

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}

HTTPcURLJavaScriptPython

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

application/json

jvmParametersstring[]Optional

Responses

200

successful operation

No content

post/spark/configuration/jvm/{managedServiceId}

HTTPcURLJavaScriptPython

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

application/json

stringOptional

Responses

200

successful operation

No content

post/spark/configuration/jvm/{managedServiceId}/json

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

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}

HTTPcURLJavaScriptPython

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

application/json

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}

HTTPcURLJavaScriptPython

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

application/json

stringOptional

Responses

200

successful operation

No content

post/spark/configuration/server/{managedServiceId}/json

HTTPcURLJavaScriptPython

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

HTTPcURLJavaScriptPython

POST /rest/spark/configuration/server/{managedServiceId}/restoreDefaults HTTP/1.1
Accept: */*

200

successful operation

No content