Documentation Powered by Redocly

estela API v1.0 Documentation (v1)

estela API Swagger Specification

api

api_account_changePassword_change

Authorizations:
Basic
Request Body schema: application/json
new_password
required
string (New password) non-empty
confirm_new_password
required
string (Confirm new password) non-empty
old_password
required
string (Old password) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password": "string",
  • "confirm_new_password": "string",
  • "old_password": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "key": "string"
}

api_account_resetPassword_confirm

Authorizations:
Basic
query Parameters
token
required
string

Token

pair
required
string

Pair

Request Body schema: application/json
new_password
required
string (New password) non-empty
confirm_new_password
required
string (Confirm new password) non-empty

Responses

Request samples

Content type
application/json
{
  • "new_password": "string",
  • "confirm_new_password": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "key": "string"
}

api_account_resetPassword_request

Authorizations:
Basic
Request Body schema: application/json
email
required
string <email> (Email) non-empty

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "email": "user@example.com"
}

api_account_resetPassword_validate

Authorizations:
Basic
query Parameters
token
required
string

Token

pair
required
string

Pair

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

api_auth_activate

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_auth_login

Authorizations:
Basic
Request Body schema: application/json
username
required
string (Username) non-empty
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "key": "string"
}

api_auth_profile_list

Authorizations:
Basic

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_auth_profile_create

Authorizations:
Basic
Request Body schema: application/json
username
required
string (Username) non-empty
email
required
string (Email) non-empty
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string"
}

api_auth_profile_read

Authorizations:
Basic
path Parameters
username
required
string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string"
}

api_auth_profile_update

Authorizations:
Basic
path Parameters
username
required
string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body schema: application/json
username
required
string (Username) non-empty
email
required
string (Email) non-empty
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string"
}

api_auth_profile_partial_update

Authorizations:
Basic
path Parameters
username
required
string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body schema: application/json
username
required
string (Username) non-empty
email
required
string (Email) non-empty
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string"
}

api_auth_profile_delete

Authorizations:
Basic
path Parameters
username
required
string^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Responses

api_auth_register

Authorizations:
Basic
Request Body schema: application/json
email
string <email> (Email address) <= 254 characters
username
required
string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

password
required
string (Password) [ 1 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "key": "string"
}

api_notifications_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_notifications_create

Authorizations:
Basic
Request Body schema: application/json
required
object (Activity)

Activity being notified.

seen
boolean (Seen)

Whether the notification was seen.

Responses

Request samples

Content type
application/json
{
  • "activity": {
    },
  • "seen": true
}

Response samples

Content type
application/json
{
  • "nid": 0,
  • "activity": {
    },
  • "seen": true
}

api_notifications_read

Authorizations:
Basic
path Parameters
nid
required
integer

A unique integer value identifying each notification

Responses

Response samples

Content type
application/json
{
  • "nid": 0,
  • "activity": {
    },
  • "seen": true
}

api_notifications_update

Authorizations:
Basic
path Parameters
nid
required
integer

A unique integer value identifying each notification

Request Body schema: application/json
seen
boolean (Seen)

Whether the notification was seen.

Responses

Request samples

Content type
application/json
{
  • "seen": true
}

Response samples

Content type
application/json
{
  • "nid": 0,
  • "seen": true
}

api_notifications_partial_update

Authorizations:
Basic
path Parameters
nid
required
integer

A unique integer value identifying each notification

Request Body schema: application/json
required
object (Activity)

Activity being notified.

seen
boolean (Seen)

Whether the notification was seen.

Responses

Request samples

Content type
application/json
{
  • "activity": {
    },
  • "seen": true
}

Response samples

Content type
application/json
{
  • "nid": 0,
  • "activity": {
    },
  • "seen": true
}

api_notifications_delete

Authorizations:
Basic
path Parameters
nid
required
integer

A unique integer value identifying each notification

Responses

api_projects_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_projects_create

Authorizations:
Basic
Request Body schema: application/json
name
required
string (Name) [ 1 .. 1000 ] characters

Project's name.

category
string (Category)
Enum: "NOT SPECIFIED" "E-COMMERCE" "LOGISTICS" "FINANCE" "EDUCATIONAL" "TECHNOLOGY" "OTHER_CATEGORY"

Project's category.

framework
string (Framework)
Enum: "SCRAPY" "REQUESTS"

Project's framework.

Array of objects (Permission)

Users with permissions on this project.

Array of objects (SpiderJobEnvVar)

Project env variables.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING"

Data status.

data_expiry_days
integer (Data expiry days) [ 0 .. 65535 ]

Days before data is deleted.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category": "NOT SPECIFIED",
  • "framework": "SCRAPY",
  • "users": [
    ],
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

Response samples

Content type
application/json
{
  • "pid": "058d15e1-c249-47bc-9c08-cb16c9e878c4",
  • "name": "string",
  • "category": "NOT SPECIFIED",
  • "framework": "SCRAPY",
  • "container_image": "string",
  • "users": [
    ],
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

api_projects_read

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

Responses

Response samples

Content type
application/json
{
  • "pid": "058d15e1-c249-47bc-9c08-cb16c9e878c4",
  • "name": "string",
  • "category": "NOT SPECIFIED",
  • "framework": "SCRAPY",
  • "container_image": "string",
  • "users": [
    ],
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

api_projects_update

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

Request Body schema: application/json
name
string (Name) non-empty

Project name.

Array of objects (UserDetail)

Affected users.

email
string <email> (Email) non-empty

Email address.

action
string (Action)
Enum: "remove" "add" "update"

Performed action.

framework
string (Framework)
Enum: "SCRAPY" "REQUESTS"

Set project framework.

Array of objects (SpiderJobEnvVar)

Project env variables.

permission
string (Permission)
Enum: "ADMIN" "DEVELOPER" "VIEWER"

New permission.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING"

New data status.

data_expiry_days
integer (Data expiry days)

New data expiry days.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "users": [
    ],
  • "email": "user@example.com",
  • "action": "remove",
  • "framework": "SCRAPY",
  • "env_vars": [
    ],
  • "permission": "ADMIN",
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0
}

Response samples

Content type
application/json
{
  • "pid": "058d15e1-c249-47bc-9c08-cb16c9e878c4",
  • "name": "string",
  • "users": [
    ],
  • "email": "user@example.com",
  • "action": "remove",
  • "framework": "SCRAPY",
  • "env_vars": [
    ],
  • "permission": "ADMIN",
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0
}

api_projects_partial_update

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

Request Body schema: application/json
name
required
string (Name) [ 1 .. 1000 ] characters

Project's name.

category
string (Category)
Enum: "NOT SPECIFIED" "E-COMMERCE" "LOGISTICS" "FINANCE" "EDUCATIONAL" "TECHNOLOGY" "OTHER_CATEGORY"

Project's category.

framework
string (Framework)
Enum: "SCRAPY" "REQUESTS"

Project's framework.

Array of objects (Permission)

Users with permissions on this project.

Array of objects (SpiderJobEnvVar)

Project env variables.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING"

Data status.

data_expiry_days
integer (Data expiry days) [ 0 .. 65535 ]

Days before data is deleted.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "category": "NOT SPECIFIED",
  • "framework": "SCRAPY",
  • "users": [
    ],
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

Response samples

Content type
application/json
{
  • "pid": "058d15e1-c249-47bc-9c08-cb16c9e878c4",
  • "name": "string",
  • "category": "NOT SPECIFIED",
  • "framework": "SCRAPY",
  • "container_image": "string",
  • "users": [
    ],
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

api_projects_delete

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

Responses

api_projects_activities

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

query Parameters
page
number

A page number within the paginated result set.

page_size
number

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 0
}

api_projects_cronjobs

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

query Parameters
page
number

A page number within the paginated result set.

page_size
number

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 0
}

api_projects_current_usage

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

Responses

Response samples

Content type
application/json
{
  • "pid": "string",
  • "name": "string",
  • "network_usage": 18446744073709552000,
  • "processing_time": "string",
  • "item_count": 18446744073709552000,
  • "request_count": 18446744073709552000,
  • "items_data_size": 18446744073709552000,
  • "requests_data_size": 18446744073709552000,
  • "logs_data_size": 18446744073709552000
}

api_projects_deploys_list

Authorizations:
Basic
path Parameters
pid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_projects_deploys_create

Authorizations:
Basic
path Parameters
pid
required
string
Request Body schema: application/json
status
string (Status)
Enum: "SUCCESS" "BUILDING" "FAILURE" "CANCELED"

Deploy status.

Responses

Request samples

Content type
application/json
{
  • "status": "SUCCESS"
}

Response samples

Content type
application/json
{
  • "did": 0,
  • "status": "SUCCESS",
  • "created": "2019-08-24T14:15:22Z",
  • "project_zip": "http://example.com"
}

api_projects_deploys_read

Authorizations:
Basic
path Parameters
did
required
integer

A unique integer value identifying this deploy.

pid
required
string

Responses

Response samples

Content type
application/json
{
  • "did": 0,
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "user": {
    },
  • "status": "SUCCESS",
  • "spiders": [
    ],
  • "created": "2019-08-24T14:15:22Z"
}

api_projects_deploys_update

Authorizations:
Basic
path Parameters
did
required
integer

A unique integer value identifying this deploy.

pid
required
string
Request Body schema: application/json
status
string (Status)
Enum: "SUCCESS" "BUILDING" "FAILURE" "CANCELED"

Deploy status.

spiders_names
Array of strings[ items [ 1 .. 1000 ] characters ]

Spider names in this deploy.

Responses

Request samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "spiders_names": [
    ]
}

Response samples

Content type
application/json
{
  • "did": 0,
  • "status": "SUCCESS",
  • "spiders_names": [
    ]
}

api_projects_deploys_partial_update

Authorizations:
Basic
path Parameters
did
required
integer

A unique integer value identifying this deploy.

pid
required
string
Request Body schema: application/json
project
required
string <uuid> (Project)

Project UUID.

required
object (UserDetail)

User details.

status
string (Status)
Enum: "SUCCESS" "BUILDING" "FAILURE" "CANCELED"

Deploy status.

Array of objects (Spider)

Spiders in this deploy.

Responses

Request samples

Content type
application/json
{
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "user": {
    },
  • "status": "SUCCESS",
  • "spiders": [
    ]
}

Response samples

Content type
application/json
{
  • "did": 0,
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "user": {
    },
  • "status": "SUCCESS",
  • "spiders": [
    ],
  • "created": "2019-08-24T14:15:22Z"
}

api_projects_deploys_delete

Authorizations:
Basic
path Parameters
did
required
integer

A unique integer value identifying this deploy.

pid
required
string

Responses

api_projects_jobs

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

query Parameters
page
number

A page number within the paginated result set.

page_size
number

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "count": 0
}

api_projects_spiders_list

Authorizations:
Basic
path Parameters
pid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_projects_spiders_read

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
integer

A unique integer value identifying this spider.

Responses

Response samples

Content type
application/json
{
  • "sid": 0,
  • "name": "string",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0
}

api_projects_spiders_update

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
integer

A unique integer value identifying this spider.

Request Body schema: application/json
Array of objects (SpiderJobEnvVar)

Project environment variables.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING"

New data status.

data_expiry_days
integer (Data expiry days)

New data expiry days.

Responses

Request samples

Content type
application/json
{
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0
}

Response samples

Content type
application/json
{
  • "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0
}

api_projects_spiders_partial_update

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
integer

A unique integer value identifying this spider.

Request Body schema: application/json
name
required
string (Name) [ 1 .. 1000 ] characters

Spider's name.

project
required
string <uuid> (Project)

Project UUID.

Array of objects (SpiderJobEnvVar)

Spider environment variables.

data_status
required
string (Data status)
Enum: "PERSISTENT" "PENDING"

Data status.

data_expiry_days
required
integer (Data expiry days)

Days before data expires.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0
}

Response samples

Content type
application/json
{
  • "sid": 0,
  • "name": "string",
  • "project": "9ec8a81a-31b2-4a83-bcd8-cef9150932d2",
  • "env_vars": [
    ],
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0
}

api_projects_spiders_cronjobs_list

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
string
query Parameters
tag
string

Cron job tag.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_projects_spiders_cronjobs_create

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
string
Request Body schema: application/json
Array of objects (SpiderJobArg)

Cron job arguments.

Array of objects (SpiderJobEnvVar)

Cron job env variables.

Array of objects (SpiderJobTag)

Cron job tags.

schedule
string (Schedule) <= 20 characters

Cron job schedule definition.

unique_collection
boolean (Unique collection)

True if this cron job stores its items in a unique collection.

data_expiry_days
required
integer (Data expiry days)

Days before data expires.

data_status
required
string (Data status)
Enum: "PERSISTENT" "PENDING" "DELETED"

Data status.

Responses

Request samples

Content type
application/json
{
  • "cargs": [
    ],
  • "cenv_vars": [
    ],
  • "ctags": [
    ],
  • "schedule": "string",
  • "unique_collection": true,
  • "data_expiry_days": 0,
  • "data_status": "PERSISTENT"
}

Response samples

Content type
application/json
{
  • "cjid": 0,
  • "name": "string",
  • "cargs": [
    ],
  • "cenv_vars": [
    ],
  • "ctags": [
    ],
  • "schedule": "string",
  • "unique_collection": true,
  • "data_expiry_days": 0,
  • "data_status": "PERSISTENT"
}

api_projects_spiders_cronjobs_read

Authorizations:
Basic
path Parameters
cjid
required
integer

A unique integer value identifying this cron job.

pid
required
string
sid
required
string

Responses

Response samples

Content type
application/json
{
  • "cjid": 0,
  • "spider": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "cargs": [
    ],
  • "cenv_vars": [
    ],
  • "ctags": [
    ],
  • "schedule": "string",
  • "status": "ACTIVE",
  • "unique_collection": true,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

api_projects_spiders_cronjobs_update

Authorizations:
Basic
path Parameters
cjid
required
integer

A unique integer value identifying this cron job.

pid
required
string
sid
required
string
Request Body schema: application/json
status
string (Status)
Enum: "ACTIVE" "DISABLED"

Cron job status.

schedule
string (Schedule) <= 20 characters

Cron job schedule definition.

unique_collection
boolean (Unique collection)

True if this cron job stores its items in a unique collection.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING"

Data status.

data_expiry_days
integer or null (Data expiry days) [ 0 .. 65535 ]

Days before data is deleted.

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "schedule": "string",
  • "unique_collection": true,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

Response samples

Content type
application/json
{
  • "cjid": 0,
  • "status": "ACTIVE",
  • "schedule": "string",
  • "unique_collection": true,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

api_projects_spiders_cronjobs_partial_update

Authorizations:
Basic
path Parameters
cjid
required
integer

A unique integer value identifying this cron job.

pid
required
string
sid
required
string
Request Body schema: application/json
Array of objects (SpiderJobArg)

Cron job arguments.

Array of objects (SpiderJobEnvVar)

Cron job env variables.

Array of objects (SpiderJobTag)

Cron job tags.

schedule
string (Schedule) <= 20 characters

Cron job schedule definition.

status
string (Status)
Enum: "ACTIVE" "DISABLED"

Cron job status.

unique_collection
boolean (Unique collection)

True if this cron job stores its items in a unique collection.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING"

Data status.

data_expiry_days
integer or null (Data expiry days) [ 0 .. 65535 ]

Days before data is deleted.

Responses

Request samples

Content type
application/json
{
  • "cargs": [
    ],
  • "cenv_vars": [
    ],
  • "ctags": [
    ],
  • "schedule": "string",
  • "status": "ACTIVE",
  • "unique_collection": true,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

Response samples

Content type
application/json
{
  • "cjid": 0,
  • "spider": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "cargs": [
    ],
  • "cenv_vars": [
    ],
  • "ctags": [
    ],
  • "schedule": "string",
  • "status": "ACTIVE",
  • "unique_collection": true,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

api_projects_spiders_cronjobs_delete

Authorizations:
Basic
path Parameters
cjid
required
integer

A unique integer value identifying this cron job.

pid
required
string
sid
required
string

Responses

api_projects_spiders_cronjobs_run_once

Authorizations:
Basic
path Parameters
cjid
required
integer

A unique integer value identifying this cron job.

pid
required
string
sid
required
string

Responses

Response samples

Content type
application/json
{
  • "cjid": 0,
  • "spider": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "cargs": [
    ],
  • "cenv_vars": [
    ],
  • "ctags": [
    ],
  • "schedule": "string",
  • "status": "ACTIVE",
  • "unique_collection": true,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 65535
}

api_projects_spiders_jobs_list

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
string
query Parameters
cronjob
number

Related cron job.

status
string

Job status.

tag
string

Job tag.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_projects_spiders_jobs_create

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
string
query Parameters
async
boolean

True if this job is async.

Request Body schema: application/json
Array of objects (SpiderJobArg)

Job arguments.

Array of objects (SpiderJobCreateEnvVar)

Job env variables.

Array of objects (SpiderJobTag)

Job tags.

cronjob
integer or null (Cronjob)

Related cron job.

data_expiry_days
integer (Data expiry days)

Days before data expires.

data_status
required
string (Data status) non-empty

Data status.

Responses

Request samples

Content type
application/json
{
  • "args": [
    ],
  • "env_vars": [
    ],
  • "tags": [
    ],
  • "cronjob": 0,
  • "data_expiry_days": 0,
  • "data_status": "string"
}

Response samples

Content type
application/json
{
  • "jid": 0,
  • "name": "string",
  • "args": [
    ],
  • "env_vars": [
    ],
  • "tags": [
    ],
  • "job_status": "string",
  • "cronjob": 0,
  • "data_expiry_days": 0,
  • "data_status": "string"
}

api_projects_spiders_jobs_read

Authorizations:
Basic
path Parameters
jid
required
integer

A unique integer value identifying this job.

pid
required
string
sid
required
string

Responses

Response samples

Content type
application/json
{
  • "jid": 0,
  • "spider": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "lifespan": 0,
  • "total_response_bytes": 18446744073709552000,
  • "item_count": 18446744073709552000,
  • "request_count": 18446744073709552000,
  • "args": [
    ],
  • "env_vars": [
    ],
  • "tags": [
    ],
  • "job_status": "string",
  • "cronjob": 0,
  • "data_expiry_days": 65535,
  • "data_status": "PERSISTENT"
}

api_projects_spiders_jobs_update

Authorizations:
Basic
path Parameters
jid
required
integer

A unique integer value identifying this job.

pid
required
string
sid
required
string
Request Body schema: application/json
status
string (Status)
Enum: "IN_QUEUE" "WAITING" "RUNNING" "STOPPED" "COMPLETED" "ERROR"

Job status.

lifespan
number (Lifespan)

The elapsed seconds the spider job was running.

total_response_bytes
integer (Total response bytes) [ 0 .. 18446744073709552000 ]

The total bytes received in responses.

item_count
integer (Item count) [ 0 .. 18446744073709552000 ]

The number of items extracted in the job.

request_count
integer (Request count) [ 0 .. 18446744073709552000 ]

The number of requests made by the spider job.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING" "DELETED"

Job data status.

data_expiry_days
integer (Data expiry days)

Job data expiry days.

proxy_usage_data
string (Proxy usage data)

Proxy Usage data.

Responses

Request samples

Content type
application/json
{
  • "status": "IN_QUEUE",
  • "lifespan": 0,
  • "total_response_bytes": 18446744073709552000,
  • "item_count": 18446744073709552000,
  • "request_count": 18446744073709552000,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0,
  • "proxy_usage_data": "string"
}

Response samples

Content type
application/json
{
  • "jid": 0,
  • "status": "IN_QUEUE",
  • "lifespan": 0,
  • "total_response_bytes": 18446744073709552000,
  • "item_count": 18446744073709552000,
  • "request_count": 18446744073709552000,
  • "data_status": "PERSISTENT",
  • "data_expiry_days": 0,
  • "proxy_usage_data": "string"
}

api_projects_spiders_jobs_partial_update

Authorizations:
Basic
path Parameters
jid
required
integer

A unique integer value identifying this job.

pid
required
string
sid
required
string
Request Body schema: application/json
lifespan
number (Lifespan)

The elapsed seconds the spider job was running.

total_response_bytes
integer (Total response bytes) [ 0 .. 18446744073709552000 ]

The total bytes received in responses.

item_count
integer (Item count) [ 0 .. 18446744073709552000 ]

The number of items extracted in the job.

request_count
integer (Request count) [ 0 .. 18446744073709552000 ]

The number of requests made by the spider job.

Array of objects (SpiderJobArg)

Job arguments.

Array of objects (SpiderJobEnvVar)

Job env variables.

Array of objects (SpiderJobTag)

Job tags.

cronjob
integer or null (Cronjob)

Related cron job.

data_expiry_days
integer or null (Data expiry days) [ 0 .. 65535 ]

Days before data is deleted.

data_status
string (Data status)
Enum: "PERSISTENT" "PENDING" "DELETED"

Data status.

Responses

Request samples

Content type
application/json
{
  • "lifespan": 0,
  • "total_response_bytes": 18446744073709552000,
  • "item_count": 18446744073709552000,
  • "request_count": 18446744073709552000,
  • "args": [
    ],
  • "env_vars": [
    ],
  • "tags": [
    ],
  • "cronjob": 0,
  • "data_expiry_days": 65535,
  • "data_status": "PERSISTENT"
}

Response samples

Content type
application/json
{
  • "jid": 0,
  • "spider": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "lifespan": 0,
  • "total_response_bytes": 18446744073709552000,
  • "item_count": 18446744073709552000,
  • "request_count": 18446744073709552000,
  • "args": [
    ],
  • "env_vars": [
    ],
  • "tags": [
    ],
  • "job_status": "string",
  • "cronjob": 0,
  • "data_expiry_days": 65535,
  • "data_status": "PERSISTENT"
}

api_projects_spiders_jobs_data_list

Authorizations:
Basic
path Parameters
jid
required
string
pid
required
string
sid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string

Spider job data type.

Responses

Response samples

Content type
application/json
{}

api_projects_spiders_jobs_data_delete

Authorizations:
Basic
path Parameters
jid
required
string
pid
required
string
sid
required
string
query Parameters
type
required
string

Spider job data type.

Responses

api_projects_spiders_jobs_data_download

Authorizations:
Basic
path Parameters
jid
required
string
pid
required
string
sid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string

Spider job data type.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

api_projects_usage

Authorizations:
Basic
path Parameters
pid
required
string <uuid>

A UUID identifying this project.

query Parameters
start_date
string

Start of date range.

end_date
string

End of date range.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_proxy_provider_list

Authorizations:
Basic
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

api_proxy_provider_create

Authorizations:
Basic
Request Body schema: application/json
name
required
string (Name) [ 1 .. 255 ] characters

A name to identify the proxy

description
required
string (Description) [ 1 .. 1000 ] characters

A description for the proxy

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "proxyid": 0
}

api_proxy_provider_read

Authorizations:
Basic
path Parameters
proxyid
required
integer

A unique integer value identifying this proxy.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "proxyid": 0
}

api_proxy_provider_update

In the request we should specify spider, project or job

Authorizations:
Basic
path Parameters
proxyid
required
integer

A unique integer value identifying this proxy.

Request Body schema: application/json
level
required
string (Level) [ 1 .. 100 ] characters

Spider or project

project_or_spider_id
required
string (Project or spider id) [ 1 .. 100 ] characters

Project id where the update will be performed

Responses

Request samples

Content type
application/json
{
  • "level": "string",
  • "project_or_spider_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "env_vars": [
    ]
}

api_proxy_provider_partial_update

Authorizations:
Basic
path Parameters
proxyid
required
integer

A unique integer value identifying this proxy.

Request Body schema: application/json
name
required
string (Name) [ 1 .. 255 ] characters

A name to identify the proxy

description
required
string (Description) [ 1 .. 1000 ] characters

A description for the proxy

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "proxyid": 0
}

api_proxy_provider_delete

Authorizations:
Basic
path Parameters
proxyid
required
integer

A unique integer value identifying this proxy.

Responses

api_stats_list

Retrieve stats of all jobs in a range of time, dates must have the format YYYY-mm-dd.

Authorizations:
Basic
path Parameters
pid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

start_date
required
string

Start of date in format [%Y-%m-%d] (e.g. 2023-04-01).

end_date
required
string

End of date in format [%Y-%m-%d] (e.g. 2023-06-02).

offset
integer

Offset between your local timezone and UTC in 'minutes'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_stats_spider_list

Retrieve stats of all spider jobs in a time range, dates must be in YYYY-mm-dd format.

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

start_date
required
string

Start of date in format [%Y-%m-%d] (e.g. 2023-04-01).

end_date
required
string

End of date in format [%Y-%m-%d] (e.g. 2023-06-02).

offset
integer

Offset between your local timezone and UTC in 'minutes'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

api_stats_spider_jobs

Retrieve all the jobs of a spider executed in a range of dates.

Authorizations:
Basic
path Parameters
pid
required
string
sid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

start_date
required
string

Start of date in format [%Y-%m-%d] (e.g. 2023-04-01).

end_date
required
string

End of date in format [%Y-%m-%d] (e.g. 2023-06-02).

offset
integer

Offset between your local timezone and UTC in 'minutes'.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_stats_spiders

Retrieve all the spiders executed in a range of dates.

Authorizations:
Basic
path Parameters
pid
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

start_date
required
string

Start of date in format [%Y-%m-%d] (e.g. 2023-04-01).

end_date
required
string

End of date in format [%Y-%m-%d] (e.g. 2023-06-02).

offset
integer

Offset between your local timezone and UTC in 'minutes'.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}