Skip to navigation

Get a job

View as Markdown

Get one job with the code of its current script.

Read the code before changing part of it with update_job, whose edits must match the current script exactly.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

job_idstringRequired

Response

OK
idstringformat: "uuid"

Pass this as job_id to the job execution tools.

namestring
archivedboolean
publish_statusenum

draft while the job is still being worked on; in_review once its author considers it ready for an admin to publish; published once it is ready for others to rely on. New jobs start as draft.

Allowed values:
tagslist of strings

User-defined categories for grouping and filtering jobs. Stored in lowercase.

network_accessenum
restricted lets the script reach the platform, the Python package index, and the allowed domains of the organization and the job. unrestricted lets it reach any host. An organization can forbid unrestricted jobs.
Allowed values:
network_allowed_domainslist of strings

Domains a restricted job reaches in addition to its organization’s. Each is a hostname, such as api.example.com, which matches that host only, or *.example.com, which matches its subdomains. Domains apply to HTTP on port 80 and HTTPS on port 443. An organization can forbid per-job domains.

descriptionstring or nullOptional
triggerobject or nullOptional
parameter_definitionslist of objects or nullOptional
script_versioninteger or nullOptional
Revision number of the job's current script, starting at 1. Each code change stores a new script and adds one.
codestring or nullOptional

Python source of the job’s current script. update_job edits match against this text.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error