Endpoints

estela offers different endpoints to interact with the users, as well as the web and queueing modules. For example:

/api/projects/{pid}/spiders

Request:

METHOD: Get
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:

200
RESPONSE SCHEMA: application/json
- count(required): integer
- next: string or null <uri>
- previous: string or null <uri>
- results(required): Array of objects(Spider)
  - array:
    - sid: integer
    - name(required): string(Name)
    - project(required): string<uuid>(Project)

estela’s endpoints documentation is generated following the OpenApi standard. You can find the full endpoints documentation at the following link.