SCscanopy
Credentials

Create credential

Changed on

Creates a credential scoped to your organization.

post/api/v1/credentials

Request

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

Request body

assigned_site_idsstring[] required

Sites this credential is assigned to (Broadcast scope). Hydrated from the site_credentials junction table.

daemon_os'Unix' | 'Windows'

The OS family of a machine a credential's paths live on. Paths, sockets and the shell a script runs in all follow from it.

descriptionstring nullable required

Free-text notes about the credential: what it is for, who owns it.

namestring required

Human-facing name for this credential.

organization_idstring uuid required

The organization that owns this record.

tagsstring[] required

Tags assigned to this entity.

created_atstring date-time required

When this record was first created.

idstring uuid required

Server-assigned unique identifier.

is_defaultboolean required

Whether this is the organization's seeded default for its type: identical to the credential every organization starts with. A default can't be deleted, and its settings can't change. Computed from credential_type, so a value sent in a request is ignored.

updated_atstring date-time required

When this record was last modified.

Example request

{
  "credential_type": {
    "broadcast_address": "192.168.1.1"
  }
}

Response

Credential created successfully

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": {
    "credential_type": {
      "broadcast_address": "192.168.1.1"
    }
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • f6cd10b4c7acRevision changes
    • breaking

      removed subschema #1: SnmpV1 subschema #2: SnmpV2c from the //// request property oneOf list

    • breaking

      added subschema #1: SnmpCommunity to the ///// response property oneOf list for the response status

    • info

      added subschema #1: SnmpCommunity to the //// request property oneOf list

    • info

      removed subschema #1: SnmpV1 subschema #2: SnmpV2c from the ///// response property oneOf list for the response status

  • e2c8e252c025Revision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 from the ///////// request property oneOf list

    • breaking

      added subschema #1: NoAuthNoPriv subschema #2: AuthNoPriv subschema #3: AuthPriv to the ////////// response property oneOf list for the response status

    • info

      added subschema #1: NoAuthNoPriv subschema #2: AuthNoPriv subschema #3: AuthPriv to the ///////// request property oneOf list

    • info

      removed subschema #1 subschema #2 subschema #3 from the ////////// response property oneOf list for the response status