File Management

ListSiteFiles retrieves all site files associated with a given site ID. Optional filters can be applied to narrow down the results.

get

Update an existing site file.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Query parameters

siteIdinteger · uint64Optional

Required.

idsinteger · uint64[]Optional

If provided, filtered on ids.

includeDatabooleanOptional

deprecated // If provided, includes data in response

pagination.offsetinteger · int64Optional

pagination.limitinteger · int64Optional

pagination.totalCountinteger · int64Optional

pagination.ordering.fieldNamestringOptional

pagination.ordering.descendingbooleanOptional

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

/gateway/v1/site-file

GET /gateway/v1/site-file HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Accept: */*

{
  "siteFiles": [
    {
      "id": 1,
      "siteId": 1,
      "filename": "text",
      "description": "text",
      "fileType": "DEFAULT_TYPE",
      "data": "text",
      "createdBy": "text",
      "updatedBy": "text",
      "created": "2025-11-28T15:11:48.633Z",
      "updated": "2025-11-28T15:11:48.633Z",
      "filepath": "text",
      "dataChunk": "Ynl0ZXM=",
      "fileSizeBytes": 1,
      "compressionType": "NO_COMPRESSION",
      "fileSchema": {},
      "dynamicLookupJob": {
        "jobId": 1,
        "status": "DYNAMIC_LOOKUP_JOB_STATUS_UNSPECIFIED",
        "resource": {
          "cpuRequest": 1,
          "cpuLimit": 1,
          "memoryRequest": 1,
          "memoryLimit": 1
        }
      },
      "status": "INACTIVE",
      "checksum": "text",
      "geoIpInfo": {
        "locale": "text",
        "storeOnManager": true
      }
    }
  ],
  "pagination": {
    "offset": 1,
    "limit": 1,
    "totalCount": 1,
    "ordering": {
      "fieldName": "text",
      "descending": true
    }
  }
}

Add a new site file to the given site.

post

Update an existing site file.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

post

/gateway/v1/site-file

POST /gateway/v1/site-file HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 578

{
  "siteFile": {
    "id": 1,
    "siteId": 1,
    "filename": "text",
    "description": "text",
    "fileType": "DEFAULT_TYPE",
    "data": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "created": "2025-11-28T15:11:48.633Z",
    "updated": "2025-11-28T15:11:48.633Z",
    "filepath": "text",
    "dataChunk": "Ynl0ZXM=",
    "fileSizeBytes": 1,
    "compressionType": "NO_COMPRESSION",
    "fileSchema": {},
    "dynamicLookupJob": {
      "jobId": 1,
      "status": "DYNAMIC_LOOKUP_JOB_STATUS_UNSPECIFIED",
      "resource": {
        "cpuRequest": 1,
        "cpuLimit": 1,
        "memoryRequest": 1,
        "memoryLimit": 1
      }
    },
    "status": "INACTIVE",
    "checksum": "text",
    "geoIpInfo": {
      "locale": "text",
      "storeOnManager": true
    }
  }
}

{
  "siteFile": {
    "id": 1,
    "siteId": 1,
    "filename": "text",
    "description": "text",
    "fileType": "DEFAULT_TYPE",
    "data": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "created": "2025-11-28T15:11:48.633Z",
    "updated": "2025-11-28T15:11:48.633Z",
    "filepath": "text",
    "dataChunk": "Ynl0ZXM=",
    "fileSizeBytes": 1,
    "compressionType": "NO_COMPRESSION",
    "fileSchema": {},
    "dynamicLookupJob": {
      "jobId": 1,
      "status": "DYNAMIC_LOOKUP_JOB_STATUS_UNSPECIFIED",
      "resource": {
        "cpuRequest": 1,
        "cpuLimit": 1,
        "memoryRequest": 1,
        "memoryLimit": 1
      }
    },
    "status": "INACTIVE",
    "checksum": "text",
    "geoIpInfo": {
      "locale": "text",
      "storeOnManager": true
    }
  }
}

Update site file, including sources, sinks or transforms. Equaivalent of patch. Only given fields are updated.

patch

Update an existing site file.

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

patch

/gateway/v1/site-file

PATCH /gateway/v1/site-file HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 578

{
  "siteFile": {
    "id": 1,
    "siteId": 1,
    "filename": "text",
    "description": "text",
    "fileType": "DEFAULT_TYPE",
    "data": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "created": "2025-11-28T15:11:48.633Z",
    "updated": "2025-11-28T15:11:48.633Z",
    "filepath": "text",
    "dataChunk": "Ynl0ZXM=",
    "fileSizeBytes": 1,
    "compressionType": "NO_COMPRESSION",
    "fileSchema": {},
    "dynamicLookupJob": {
      "jobId": 1,
      "status": "DYNAMIC_LOOKUP_JOB_STATUS_UNSPECIFIED",
      "resource": {
        "cpuRequest": 1,
        "cpuLimit": 1,
        "memoryRequest": 1,
        "memoryLimit": 1
      }
    },
    "status": "INACTIVE",
    "checksum": "text",
    "geoIpInfo": {
      "locale": "text",
      "storeOnManager": true
    }
  }
}

{
  "siteFile": {
    "id": 1,
    "siteId": 1,
    "filename": "text",
    "description": "text",
    "fileType": "DEFAULT_TYPE",
    "data": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "created": "2025-11-28T15:11:48.633Z",
    "updated": "2025-11-28T15:11:48.633Z",
    "filepath": "text",
    "dataChunk": "Ynl0ZXM=",
    "fileSizeBytes": 1,
    "compressionType": "NO_COMPRESSION",
    "fileSchema": {},
    "dynamicLookupJob": {
      "jobId": 1,
      "status": "DYNAMIC_LOOKUP_JOB_STATUS_UNSPECIFIED",
      "resource": {
        "cpuRequest": 1,
        "cpuLimit": 1,
        "memoryRequest": 1,
        "memoryLimit": 1
      }
    },
    "status": "INACTIVE",
    "checksum": "text",
    "geoIpInfo": {
      "locale": "text",
      "storeOnManager": true
    }
  }
}

Delete a site file

delete

Deletes a specific file associated with a site

Authorizations

authorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Path parameters

siteIdinteger · uint64Required

ID of the site that owns the file

siteFileIdinteger · uint64Required

ID of the file to delete

Responses

200

File deleted successfully

application/json

404

File or site not found

500

Internal server error

delete

/gateway/v1/site-file/{siteId}/{siteFileId}

DELETE /gateway/v1/site-file/{siteId}/{siteFileId} HTTP/1.1
Host: p01-api.observo.ai
authorization: YOUR_API_KEY
Accept: */*

{
  "code": "OK",
  "errorMessage": "text",
  "userMessageCode": "DEFAULT"
}

PreviousSite NextSource

Last updated 4 months ago

Was this helpful?