Upload Logs

UploadLogsRequest

Topic: josev/cs. Used by Josev to request the CS to upload logs to a remote server.

type

object

properties

  • id

type

string

format

uuid

  • name

const

upload_logs

  • type

const

request

  • data

type

object

properties

  • request_id

type

integer

  • log_type

enum

diagnostics_log, security_log

  • remote_location

type

string

pattern

^(https?|ftps?|sftp)://

format

uri

  • retries

type

integer

  • retry_interval

type

integer

  • oldest_timestamp

type

string

pattern

^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}(\.\d{1,3})?([Zz]|([+-])\d{2}:\d{2})?$

format

date-time

  • latest_timestamp

type

string

pattern

^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}(\.\d{1,3})?([Zz]|([+-])\d{2}:\d{2})?$

format

date-time

Example:

{
    "id": "86bfba63-a44f-40cc-8b4b-dc4c9d771e52",
    "name": "upload_logs",
    "type": "request",
    "data": {
        "request_id": 12345,
        "log_type": "diagnostics_log", # security_log
        "remote_location": "https://josev-logs.s3.eu-west-2.amazonaws.com",
        "retries": 3, # [Optional]
        "retry_interval": 60, # [Optional]
        "oldest_timestamp": "2021-11-10T17:29:37Z", # [Optional]
        "latest_timestamp": "2021-11-10T19:29:37Z" # [Optional]
    }
}

UploadLogsResponse

Topic: cs/josev. Used to acknowledge the upload logs request.

type

object

properties

  • id

type

string

format

uuid

  • name

const

upload_logs

  • type

const

response

  • data

type

object

properties

  • status

enum

accepted, rejected, accepted_canceled

  • filename

type

string

Example:

{
    "id": "86bfba63-a44f-40cc-8b4b-dc4c9d771e52",
    "name": "upload_logs",
    "type": "response",
    "data": {
        "status": "accepted", # rejected, accepted_canceled
        "filename": "josev-2022-09-29.log" # [Optional]
    },
}