SCscanopy
Discoveries

Update discovery

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

Request

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

Path parameters

idstring uuid required

Discovery ID

Request body

daemon_idstring uuid required

The daemon this entity refers to.

namestring required

Human-facing name for this discovery.

site_idstring uuid required

The site this entity belongs to.

tagsstring[] required

Tags assigned to this entity.

created_atstring date-time required

When this record was first created.

force_full_scanboolean

When true, the next scan will be a full port scan regardless of interval

idstring uuid required

Server-assigned unique identifier.

next_run_is_full_scanboolean

Whether the next run of this discovery will be a full scan of all 65,535 ports rather than a light scan of common ports. Computed by the server on read and never stored.

scan_countinteger

Number of completed scans (incremented by server on session completion)

updated_atstring date-time required

When this record was last modified.

Response

Discovery updated successfully

errorstring nullable

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

successboolean required

Always true on a successful response.

Changes

  • c94279effef3Revision changes
    • breaking

      added subschema #56 to the ///////// response property oneOf list for the response status

    • info

      added subschema #56 to the //////// request property oneOf list

  • 959e33713b20Revision changes
    • warning

      added the new DaemonDroppedSession enum value to the //////////// response property for the response status

    • warning

      added the new DaemonOffline enum value to the //////////// response property for the response status

    • warning

      added the new SessionSilent enum value to the //////////// response property for the response status

    • info

      added the new DaemonDroppedSession enum value to the request property ///////////

    • info

      added the new DaemonOffline enum value to the request property ///////////

    • info

      added the new SessionSilent enum value to the request property ///////////