v1

latestOpenAPI 3.0.22026-07-174617345.8 KB

Sources

Update agent source settings.

Update a data source settings, allowing you to change additional settings.

put/api/v1/projects/{projectId}/sources/{sourceId}

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

sourceIdinteger required

Request body

executive_jsboolean

Whether the agent source should execute JavaScript

data_refresh_frequencystring

The agent source data refresh frequency

create_new_pagesboolean

Add new pages to agent automatically during refresh agent source

remove_unexist_pagesboolean

Remove pages from agent automatically during refresh agent source

refresh_existing_pagesstring

Refresh existing page during refresh agent source

Example request

{
  "executive_js": true,
  "data_refresh_frequency": "never",
  "create_new_pages": true,
  "refresh_existing_pages": "never",
  "refresh_schedule": [
    {
      "days": [
        0,
        1,
        4,
        6
      ],
      "hours": [
        "00:00",
        "08:00",
        "23:45"
      ]
    }
  ]
}

Response

Successfully updated agent source.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "id": 1,
    "created_at": "2021-01-01 00:00:00",
    "updated_at": "2021-01-01 00:00:00",
    "type": "sitemap",
    "settings": {
      "executive_js": true,
      "data_refresh_frequency": "never",
      "create_new_pages": true,
      "refresh_existing_pages": "never",
      "sitemap_path": "https://example.com/sitemap.xml"
    },
    "pages": [
      {
        "id": 1,
        "page_url": "https://example.com",
        "page_url_hash": "d41d8cd98f00b204e9800998ecf8427e",
        "project_id": 1,
        "s3_path": "project-1/page-1/file.pdf",
        "crawl_status": "queued",
        "index_status": "queued",
        "is_file": true,
        "is_refreshable": true,
        "is_file_kept": true,
        "filename": "file.pdf",
        "filesize": 100,
        "created_at": "2021-01-01 00:00:00",
        "updated_at": "2021-01-01 00:00:00",
        "deleted_at": "2021-01-01 00:00:00"
      }
    ]
  }
}