SCscanopy
Credentials

Get credential by ID

Changed on
get/api/v1/credentials/{id}

Request

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

Path parameters

idstring uuid required

Credential ID

Response

Credential found

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

  • c9d9d46d1ae8Revision changes
    • info

      api operation id get_by_id_credential removed and replaced with get_credential_by_id

  • f6cd10b4c7acRevision changes
    • breaking

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

    • info

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