Schedules

List Schedules

get

Gets a list of schedules.

Args: schedule_filter_model: Filter model used for pagination, sorting, filtering project_name_or_id: Optional name or ID of the project. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: List of schedule objects.

Authorizations

Query parameters

project_name_or_idany ofOptional

stringOptional

or

string · uuidOptional

or

nullOptional

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

scope_userany ofOptional

string · uuidOptional

or

nullOptional

userany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

projectany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

pipeline_idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

orchestrator_idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

activeany ofOptional

booleanOptional

or

nullOptional

cron_expressionany ofOptional

stringOptional

or

nullOptional

start_timeany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

end_timeany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

interval_secondany ofOptional

numberOptional

or

nullOptional

catchupany ofOptional

booleanOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

run_once_start_timeany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/schedules HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "active": true,
        "cron_expression": "text",
        "start_time": "2025-04-26T17:46:46.324Z",
        "end_time": "2025-04-26T17:46:46.324Z",
        "interval_second": "text",
        "catchup": true,
        "run_once_start_time": "2025-04-26T17:46:46.324Z"
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "orchestrator_id": "123e4567-e89b-12d3-a456-426614174000",
        "pipeline_id": "123e4567-e89b-12d3-a456-426614174000",
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Get Schedule

get

Gets a specific schedule using its unique id.

Args: schedule_id: ID of the schedule to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: A specific schedule object.

Authorizations

Path parameters

schedule_idstring · uuidRequired

Query parameters

hydratebooleanOptionalDefault: true

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/schedules/{schedule_id} HTTP/1.1
Host: 
Accept: */*

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "active": true,
    "cron_expression": "text",
    "start_time": "2025-04-26T17:46:46.324Z",
    "end_time": "2025-04-26T17:46:46.324Z",
    "interval_second": "text",
    "catchup": true,
    "run_once_start_time": "2025-04-26T17:46:46.324Z"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "orchestrator_id": "123e4567-e89b-12d3-a456-426614174000",
    "pipeline_id": "123e4567-e89b-12d3-a456-426614174000",
    "run_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Update Schedule

put

Updates the attribute on a specific schedule using its unique id.

Args: schedule_id: ID of the schedule to get. schedule_update: the model containing the attributes to update.

Returns: The updated schedule object.

Authorizations

Path parameters

schedule_idstring · uuidRequired

Body

Update model for schedules.

nameany ofOptional

stringOptional

or

nullOptional

Responses

put

HTTPcURLJavaScriptPython

PUT /api/v1/schedules/{schedule_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "active": true,
    "cron_expression": "text",
    "start_time": "2025-04-26T17:46:46.324Z",
    "end_time": "2025-04-26T17:46:46.324Z",
    "interval_second": "text",
    "catchup": true,
    "run_once_start_time": "2025-04-26T17:46:46.324Z"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "orchestrator_id": "123e4567-e89b-12d3-a456-426614174000",
    "pipeline_id": "123e4567-e89b-12d3-a456-426614174000",
    "run_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Delete Schedule

delete

Deletes a specific schedule using its unique id.

Args: schedule_id: ID of the schedule to delete.

Authorizations

Path parameters

schedule_idstring · uuidRequired

Responses

Responseany

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/schedules/{schedule_id} HTTP/1.1
Host: 
Accept: */*

No content