Get Service Logs - Cycls

Get Service Logs

curl --request POST \
  --url https://api.cycls.ai/v1/deployment/logs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "deployment_name": "my-function",
  "since": "2023-11-07T05:31:56Z",
  "limit": 100,
  "query": "<string>"
}
'

import requests

url = "https://api.cycls.ai/v1/deployment/logs"

payload = {
    "deployment_name": "my-function",
    "since": "2023-11-07T05:31:56Z",
    "limit": 100,
    "query": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deployment_name: 'my-function',
    since: '2023-11-07T05:31:56Z',
    limit: 100,
    query: '<string>'
  })
};

fetch('https://api.cycls.ai/v1/deployment/logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "logs": [
    {
      "timestamp": "2024-01-15T10:30:00+00:00",
      "severity": "DEFAULT",
      "message": "INFO: 127.0.0.1 - \"GET / HTTP/1.1\" 200 OK"
    }
  ],
  "cursor": "<string>"
}

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

POST

https://api.cycls.ai

/

v1

/

deployment

/

logs

Get Service Logs

curl --request POST \
  --url https://api.cycls.ai/v1/deployment/logs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "deployment_name": "my-function",
  "since": "2023-11-07T05:31:56Z",
  "limit": 100,
  "query": "<string>"
}
'

import requests

url = "https://api.cycls.ai/v1/deployment/logs"

payload = {
    "deployment_name": "my-function",
    "since": "2023-11-07T05:31:56Z",
    "limit": 100,
    "query": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deployment_name: 'my-function',
    since: '2023-11-07T05:31:56Z',
    limit: 100,
    query: '<string>'
  })
};

fetch('https://api.cycls.ai/v1/deployment/logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "logs": [
    {
      "timestamp": "2024-01-15T10:30:00+00:00",
      "severity": "DEFAULT",
      "message": "INFO: 127.0.0.1 - \"GET / HTTP/1.1\" 200 OK"
    }
  ],
  "cursor": "<string>"
}

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

Authorizations

X-API-Key

string

header

required

Your Cycls API key, from https://cloud.cycls.com. Sent as the X-API-Key header. This is the CYCLS_API_KEY the CLI uses.

Body

application/json

deployment_name

string

required

Service name to fetch logs for

Example:

"my-function"

since

string<date-time> | null

Fetch logs after this timestamp (use cursor from previous response)

limit

integer

default:100

Maximum number of log entries to return

Required range: 1 <= x <= 1000

query

string | null

Cloud Logging filter expression to AND with the base filter (e.g. 'jsonPayload.level="error"'). Parentheses must be balanced.

Response

Successful Response

logs

LogEntry · object[]

required

List of log entries (oldest first)

Show child attributes

cursor

string | null

Pass as 'since' to fetch newer logs