> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/console/jobserver-configuration.md). # Jobserver Configuration ## GET /spark/configuration/contextJvm/{managedServiceId} > Get Jobserver's Monitoring JVM configuration. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/contextJvm/{managedServiceId}":{"get":{"operationId":"getJobserverContextJvmConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"summary":"Get Jobserver's Monitoring JVM configuration. Requires super role.","tags":["jobserver-configuration"]}}}} ``` ## POST /spark/configuration/contextJvm/{managedServiceId} > Overwrite Jobserver's Monitoring JVM configuration. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/contextJvm/{managedServiceId}":{"post":{"operationId":"updateJobserverContextJvmConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JvmConfiguration"}}}},"responses":{"200":{"description":"successful operation"}},"summary":"Overwrite Jobserver's Monitoring JVM configuration. Requires super role.","tags":["jobserver-configuration"]}}},"components":{"schemas":{"JvmConfiguration":{"type":"object","properties":{"jvmParameters":{"type":"array","items":{"type":"string"}}}}}}} ``` ## POST /spark/configuration/contextJvm/{managedServiceId}/json > Update Jobserver's Monitoring JVM configuration with JSON. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/contextJvm/{managedServiceId}/json":{"post":{"operationId":"updateJobserverContextJvmWithJson","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"successful operation"}},"summary":"Update Jobserver's Monitoring JVM configuration with JSON. Requires super role.","tags":["jobserver-configuration"]}}}} ``` ## POST /spark/configuration/contextJvm/{managedServiceId}/restoreDefaults > Restore Jobserver's Monitoring JVM configuration to default. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/contextJvm/{managedServiceId}/restoreDefaults":{"post":{"operationId":"restoreDefaultJobserverContextJVMConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"summary":"Restore Jobserver's Monitoring JVM configuration to default. Requires super role.","tags":["jobserver-configuration"]}}}} ``` ## GET /spark/configuration/jvm/{managedServiceId} > Get Jobserver's JVM configuration. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/jvm/{managedServiceId}":{"get":{"operationId":"getJobserverJvmConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"summary":"Get Jobserver's JVM configuration. Requires super role.","tags":["jobserver-configuration"]}}}} ``` ## POST /spark/configuration/jvm/{managedServiceId} > Overwrite Jobserver's JVM configuration. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/jvm/{managedServiceId}":{"post":{"operationId":"updateJobserverJvmConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JvmConfiguration"}}}},"responses":{"200":{"description":"successful operation"}},"summary":"Overwrite Jobserver's JVM configuration. Requires super role.","tags":["jobserver-configuration"]}}},"components":{"schemas":{"JvmConfiguration":{"type":"object","properties":{"jvmParameters":{"type":"array","items":{"type":"string"}}}}}}} ``` ## POST /spark/configuration/jvm/{managedServiceId}/json > Update Jobserver's JVM configuration with JSON. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/jvm/{managedServiceId}/json":{"post":{"operationId":"updateJobserverJvmWithJson","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"successful operation"}},"summary":"Update Jobserver's JVM configuration with JSON. Requires super role.","tags":["jobserver-configuration"]}}}} ``` ## POST /spark/configuration/jvm/{managedServiceId}/restoreDefaults > Restore Jobserver's JVM configuration to default. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/jvm/{managedServiceId}/restoreDefaults":{"post":{"operationId":"restoreDefaultJobserverJVMConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"summary":"Restore Jobserver's JVM configuration to default. Requires super role.","tags":["jobserver-configuration"]}}}} ``` ## GET /spark/configuration/server/definition > Get Jobserver's Server configuration definition. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/server/definition":{"get":{"operationId":"getJobserverServerConfigurationDefinition","responses":{"200":{"description":"successful operation"}},"summary":"Get Jobserver's Server configuration definition. ","tags":["jobserver-configuration"]}}}} ``` ## GET /spark/configuration/server/{managedServiceId} > Get Jobserver's Server configuration. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/server/{managedServiceId}":{"get":{"operationId":"getJobserverServerConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"summary":"Get Jobserver's Server configuration. ","tags":["jobserver-configuration"]}}}} ``` ## POST /spark/configuration/server/{managedServiceId} > Overwrite Jobserver's JVM configuration. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/server/{managedServiceId}":{"post":{"operationId":"overwriteJobserverServerConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobserverServerConfiguration"}}}},"responses":{"200":{"description":"successful operation"}},"summary":"Overwrite Jobserver's JVM configuration. Requires super role.","tags":["jobserver-configuration"]}}},"components":{"schemas":{"JobserverServerConfiguration":{"type":"object","properties":{"jobserverMemory":{"type":"string"},"jobserverMonitoringPort":{"type":"integer","format":"int32","maximum":65535,"minimum":0},"jobserverSecurityConfiguration":{"$ref":"#/components/schemas/JobserverSecurityConfiguration"},"port":{"type":"integer","format":"int32","maximum":65535,"minimum":0},"sparkMemory":{"type":"string"},"sparkMonitoringPort":{"type":"integer","format":"int32","maximum":65535,"minimum":0}},"required":["jobserverMemory","jobserverMonitoringPort","port","sparkMemory","sparkMonitoringPort"]},"JobserverSecurityConfiguration":{"type":"object","properties":{"authentication":{"type":"string","enum":["NONE","SERVER","MUTUAL"]},"certificateChain":{"type":"string"},"privateKey":{"type":"string"},"trustedCertificate":{"type":"string"}}}}}} ``` ## POST /spark/configuration/server/{managedServiceId}/json > Update Jobserver's JVM configuration with JSON. Requires super role. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/server/{managedServiceId}/json":{"post":{"operationId":"updateJobserverServerConfigurationWithJson","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"successful operation"}},"summary":"Update Jobserver's JVM configuration with JSON. Requires super role.","tags":["jobserver-configuration"]}}}} ``` ## POST /spark/configuration/server/{managedServiceId}/restoreDefaults > Get Jobserver's Server configuration. ```json {"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/spark/configuration/server/{managedServiceId}/restoreDefaults":{"post":{"operationId":"restoreDefaultJobserverServerConfiguration","parameters":[{"in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation"}},"summary":"Get Jobserver's Server configuration. ","tags":["jobserver-configuration"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.collibra.com/api/references/console/jobserver-configuration.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.