Pause Connection Sync Policy - Cognee Documentation

POST

/

api

/

v1

/

integrations

/

{provider}

/

sync

/

policy

/

pause

Pause Connection Sync Policy

curl --request POST \
  --url https://{tenant}.aws.cognee.ai/api/v1/integrations/{provider}/sync/policy/pause \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant}.aws.cognee.ai/api/v1/integrations/{provider}/sync/policy/pause"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "level": "default",
  "intervalMinutes": 123,
  "weekdays": [
    123
  ],
  "timezone": "<string>",
  "paused": true,
  "pausedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pausedAt": "2023-11-07T05:31:56Z",
  "nextDueAt": "2023-11-07T05:31:56Z",
  "heldBy": "default",
  "intervalPresets": [
    15,
    30,
    60,
    120,
    240,
    360,
    480,
    1440,
    10080
  ],
  "customHours": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11,
    12,
    13,
    14,
    15,
    16,
    17,
    18,
    19,
    20,
    21,
    22,
    23
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

provider

string

required

Query Parameters

account_id

string | null

Response

Successful Response

A saved sync policy, with the intervals a UI may offer, so it hard-codes none.

level is default for the owner's default and connection for one connection's own policy. On a connection's routes held_by names the level that holds it paused: a paused default holds it even when its own row is not. Times are UTC.

level

enum<string>

required

Available options:

default,

connection

intervalMinutes

integer

required

weekdays

integer[]

required

timezone

string

required

paused

boolean

required

pausedBy

string<uuid> | null

required

pausedAt

string<date-time> | null

required

nextDueAt

string<date-time> | null

required

heldBy

enum<string> | null

Available options:

default,

connection

intervalPresets

integer[]

customHours

integer[]

⌘I

Pause Connection Sync Policy

curl --request POST \
  --url https://{tenant}.aws.cognee.ai/api/v1/integrations/{provider}/sync/policy/pause \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant}.aws.cognee.ai/api/v1/integrations/{provider}/sync/policy/pause"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "level": "default",
  "intervalMinutes": 123,
  "weekdays": [
    123
  ],
  "timezone": "<string>",
  "paused": true,
  "pausedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pausedAt": "2023-11-07T05:31:56Z",
  "nextDueAt": "2023-11-07T05:31:56Z",
  "heldBy": "default",
  "intervalPresets": [
    15,
    30,
    60,
    120,
    240,
    360,
    480,
    1440,
    10080
  ],
  "customHours": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11,
    12,
    13,
    14,
    15,
    16,
    17,
    18,
    19,
    20,
    21,
    22,
    23
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}