REST API

Authentication
Run it NOW
REST APIs

Authentication

If authentication is enabled, then the API must login and save the cookie to be used for the API calls.

Example with curl:

curl --silent --output /dev/null \
     --data-urlencode "username=user" \
     --data-urlencode 'password=Very$ecret' \
     --cookie-jar - 'http://localhost:8887/login' \
     > my_cookie.txt

curl --cookie my_cookie.txt \
     -X POST \
     --header "Content-Type:application/json" \
     --data "{\"job_class_string\": \"simple_scheduler.jobs.sample_job.AwesomeJob\", \
              \"name\": \"My first job\", \"minute\": \"*/1\", \"pub_args\": [\"arg1\", 2]}" \
     localhost:8887/api/v1/jobs \

Run it NOW

    # Start server
    $ git clone https://github.com/Nextdoor/ndscheduler.git
    $ cd ndscheduler
    $ make simple
 
    # Add a job
    $ curl -X POST localhost:8888/api/v1/jobs \
       --header "Content-Type:application/json" \
       -d "{\"job_class_string\": \"simple_scheduler.jobs.sample_job.AwesomeJob\", \
            \"name\": \"My first job\", \"minute\": \"*/1\", \"pub_args\": [\"arg1\", 2]}"
 
    # Get all jobs
    $ curl localhost:8888/api/v1/jobs

REST APIs

Jobs

Get all jobs

Returns json data for all jobs.

URL

/api/v1/jobs
Method:

GET
URL Params

None
Data Params

None

Success Response:

Code: 200 OK

Content:

{
    jobs: [{
        "job_id": "d8f376e858a411e4b6ae22000ac58d05",
        "job_class_string": "simple_scheduler.jobs.clean_apns.CleanAPNsJob",
        "name": "Clean APNs",
        "pub_args": ["arg1": 1, "arg2": 2],
        "month": "*",
        "day_of_week": "*",
        "day": "*",
        "hour": "*/1",
        "minute": "*"
    },
    ...]
}

Error Response:

Code: 400 Bad Request

Content:

        { error: "incorrect parameters" }

OR

Code: 500 Internal Server Error

Content:
```
        { error: "server side error" }
```

Sample Call:

    $.ajax({
      url: "/api/v1/jobs",
      dataType: "json",
      type : "GET",
      success : function(r) {
        console.log(r);
      }
    });

Get a job

Returns json data for a job.

URL

/api/v1/jobs/:job_id:
Method:

GET
URL Params

None
Data Params

None

Success Response:

Code: 200 OK

Content:

{
  "job_id": "d8f376e858a411e4b6ae22000ac58d05",
  "job_class_string": "simple_scheduler.jobs.clean_apns.CleanAPNsJob",
  "name": "Clean APNs",
  "pub_args": ["arg1": 1, "arg2": 2],
  "month": "*",
  "day_of_week": "*",
  "day": "*",
  "hour": "*/1",
  "minute": "*"
}

Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error ****
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/jobs/ad9bb256a2ee11e5bbf702ba903740c3",
    dataType: "json",
    type : "GET",
    success : function(r) {
      console.log(r);
    }
  });

Create a new job

Create a new job and return the job id.

URL

/api/v1/jobs
Method:

POST
URL Params

None

Data Params

{
    "job_class_string": "simple_scheduler.jobs.clean_apns.CleanAPNsJob",
    "name": "Clean APNs",
    "pub_args": ["arg1": 1, "arg2": 2],
    "month": "*",
    "day_of_week": "*",
    "day": "*",
    "hour": "*/1",
    "minute": "*"
}

Required fields: job_class_string and name

Success Response:
- Code: 201 Created
  
  Content: { job_id: "d8f376e858a411e4b6ae32000ac58d05"}
Error Response:
- Code: 400 Bad Request
  
  Content: { error: "incorrect parameters" }
OR
- Code: 500 Internal Server Error
  
  Content: { error: "server side error" }

Sample Call:

  $.ajax({
    url: "/api/v1/jobs",
    dataType: "json",
    contentType: "application/json",
    type : "POST",
    data: {
          "job_class_string": "simple_scheduler.jobs.clean_apns.CleanAPNsJob",
          "name": "Clean APNs",
          "pub_args": ["arg1": 1, "arg2": 2],
          "month": "*",
          "day_of_week": "*",
          "day": "*",
          "hour": "*/1",
          "minute": "*"
    },
    success : function(r) {
      console.log(r);
    }
  });

Delete a job

Delete a job and returns json data for old job id.

URL

/api/v1/jobs/:job_id:
Method:

DELETE
URL Params

None
Data Params

None

Success Response:

Code: 200 OK

Content:

{
  "job_id": "d8f376e858a411e4b6ae22000ac58d05"
}

Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/jobs/d8f376e858a411e4b6ae22000ac58d05",
    dataType: "json",
    type : "DELETE",
    success : function(r) {
      console.log(r);
    }
  });

Modify a job

Modify a job and returns json data for job id.

URL

/api/v1/jobs/:job_id:
Method:

PUT
URL Params

None

Data Params

{
    "job_class_string": "simple_scheduler.jobs.clean_apns.CleanAPNsJob",
    "name": "Clean APNs",
    "pub_args": ["arg1": 1, "arg2": 2],
    "month": "*",
    "day_of_week": "*",
    "day": "*",
    "hour": "*/1",
    "minute": "*"
}

Success Response:

Code: 200 OK Content:

{
  "job_id": "d8f376e858a411e4b6ae22000ac58d05"
}

Error Response:

Code: 400 Bad Request Content:

        { error: "incorrect parameters" }

OR

Code: 500 Internal Server Error

Content:
```
        { error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/jobs/d8f376e858a411e4b6ae22000ac58d05",
    dataType: "json",
    type : "PUT",
    success : function(r) {
      console.log(r);
    }
  });

Pause a job

Pause a job and returns json data for job id.

URL

/api/v1/jobs/:job_id:
Method:

PATCH
URL Params

None
Data Params

None

Success Response:

Code: 200 OK

Content:

{
  "job_id": "d8f376e858a411e4b6ae22000ac58d05",
}

Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/jobs/d8f376e858a411e4b6ae22000ac58d05",
    dataType: "json",
    type : "PATCH",
    success : function(r) {
      console.log(r);
    }
  });

Resume a job

Resume a paused job and returns json data for job id.

URL

/api/v1/jobs/:job_id:
Method:

OPTIONS
URL Params

None
Data Params

None

Success Response:

Code: 200 OK

Content:

{
  "job_id": "d8f376e858a411e4b6ae22000ac58d05",
}

Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/jobs/d8f376e858a411e4b6ae22000ac58d05",
    dataType: "json",
    type : "OPTIONS",
    success : function(r) {
      console.log(r);
    }
  });

Executions

Get executions within time range

Returns json data for all executions within given time range.

URL

/api/v1/executions
Method:

GET
URL Params

time_range_start=2015-12-19T00:31:50.313Z time_range_end=2015-12-19T01:31:50.313Z
Data Params

None

Success Response:

Code: 200 OK

Content:

{
    executions: [{
        description: "",
        execution_id: "7252d7a6a80f11e58bcc02ba903740c3",
        hostname: "",
        job: {
            day: "*",
            day_of_week: "*",
            hour: "*",
            job_id: "bb0dec52797f11e4a14122000a150f89",
            minute: "*/5",
            month: "*",
            name: "Poll sendgrid for bounces and spamreports",
            pub_args: [],
            job_class_string: "simple_scheduler.jobs.sample_job.ImportDataJob",
            week: "*"
        },
        pid: -1,
        scheduled_time: "2015-12-21T18:20:05.604708+00:00",
        state: "scheduled",
        task_id: "",
        updated_time: "2015-12-21T18:20:05.604732+00:00"
    },
    ...]
}

Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/executions?time_range_end=2015-12-19T01:31:50.313Z&time_range_start=2015-12-19T00:31:50.313Z",
    dataType: "json",
    type : "GET",
    success : function(r) {
      console.log(r);
    }
  });

Get an execution

Returns json data for an execution.

URL

/api/v1/executions/:execution_id:
Method:

GET
URL Params

None
Data Params

None

Success Response:

Code: 200 OK

Content:

{
    description: "",
    execution_id: "7252d7a6a80f11e58bcc02ba903740c3",
    hostname: "",
    job: {
        day: "*",
        day_of_week: "*",
        hour: "*",
        job_id: "bb0dec52797f11e4a14122000a150f89",
        minute: "*/5",
        month: "*",
        name: "Poll sendgrid for bounces and spamreports",
        pub_args: [],
        job_class_string: "simple_scheduler.jobs.sample_job.ImportDataJob",
        week: "*"
    },
    pid: -1,
    scheduled_time: "2015-12-21T18:20:05.604708+00:00",
    state: "scheduled",
    task_id: "",
    updated_time: "2015-12-21T18:20:05.604732+00:00"
}

Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/executions/d8f376e858a411e4b6ae22000ac58d05",
    dataType: "json",
    type : "GET",
    success : function(r) {
      console.log(r);
    }
  });

Run a job

Run a job (create an execution) and returns json data for execution id.

URL

/api/v1/executions
Method:

POST
URL Params

None
Data Params

None
Success Response:
- Code: 200 OK
  
  Content: { execution_id: "d8f376e858a411e4b6ae32000ac58d05" }
Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/executions",
    dataType: "json",
    type : "POST",
    success : function(r) {
      console.log(r);
    }
  });

Audit Logs

Get logs within time range

Returns json data for audit logs within given time range.

URL

/api/v1/logs
Method:

GET
URL Params

time_range_start=2015-12-19T00:31:50.313Z time_range_end=2015-12-19T01:31:50.313Z
Data Params

None

Success Response:

Code: 200 OK

Content:

{
    logs: [{
            created_time: "2015-12-19T01:20:23.843895+00:00"
            description: "ad9bb256a2ee11e5bbf702ba903740c3"
            event: "custom_run"
            job_id: "5052939245f611e5bef70610a8516d8b"
            job_name: "Import Data Job"
            user: "wenbin"
    },
    ...]
}

Error Response:
- Code: 400 Bad Request
  
  Content:
```
{ error: "incorrect parameters" }
```
OR
- Code: 500 Internal Server Error
  
  Content:
```
{ error: "server side error" }
```

Sample Call:

  $.ajax({
    url: "/api/v1/logs?time_range_end=2015-12-19T01:31:50.313Z&time_range_start=2015-12-19T00:31:50.313Z",
    dataType: "json",
    type : "GET",
    success : function(r) {
      console.log(r);
    }
  });

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

REST API

Authentication

Run it NOW

REST APIs

Jobs

Get all jobs

Get a job

Create a new job

Delete a job

Modify a job

Pause a job

Resume a job

Executions

Get executions within time range

Get an execution

Run a job

Audit Logs

Get logs within time range

Files

README.md

Latest commit

History

README.md

File metadata and controls

REST API

Authentication

Run it NOW

REST APIs

Jobs

Get all jobs

Get a job

Create a new job

Delete a job

Modify a job

Pause a job

Resume a job

Executions

Get executions within time range

Get an execution

Run a job

Audit Logs

Get logs within time range