SCscanopy
Sites

Update site

Changed on
put/api/v1/sites/{id}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/sites/{id}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Site ID

Request body

credential_idsstring[] nullable

Credential IDs assigned to this site (hydrated from the junction table, so always present in a response). On create, omitting it assigns the organization's site-wide default credentials and a list, even an empty one, is used exactly. On update, omitting it leaves the assignments unchanged.

namestring required

Human-facing name for this site.

organization_idstring uuid required

The organization that owns this record.

stale_after_hoursinteger nullable required

How long a discovery-managed entity on this site may go unobserved before it reads as stale. None = unset; callers resolve the effective value through [Site::stale_after], never by reading this directly.

Site-scoped because staleness is only meaningful relative to scan cadence, and cadence is a property of a site's discoveries.

tagsstring[] required

Tags assigned to this entity.

created_atstring date-time required

When this record was first created.

effective_stale_after_hoursinteger

stale_after_hours with the server's default already applied.

Computed, never stored (excluded from to_params). Published so the frontend derives staleness from the same number the digest uses rather than re-declaring the default in TypeScript, where the two could drift and a host could read stale in the app but current in the digest email.

idstring uuid required

Server-assigned unique identifier.

updated_atstring date-time required

When this record was last modified.

Example request

{
  "created_at": "2026-01-15T10:30:00Z",
  "credential_ids": [],
  "effective_stale_after_hours": 672,
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "name": "Home Site",
  "organization_id": "550e8400-e29b-41d4-a716-446655440001",
  "stale_after_hours": null,
  "tags": [],
  "updated_at": "2026-01-15T10:30:00Z"
}

Response

Site updated

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "credential_ids": [],
    "effective_stale_after_hours": 672,
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "name": "Home Site",
    "organization_id": "550e8400-e29b-41d4-a716-446655440001",
    "stale_after_hours": null,
    "tags": [],
    "updated_at": "2026-01-15T10:30:00Z"
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c305a1f5ae29Revision changes
    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became optional for the status

    • info

      the request property //// became nullable

    • info

      the request property //// became optional

  • a6ea2ab6fbb9Revision changes
    • info

      endpoint added