Syslog Profiles

Creates,gets tenant syslog profiles

List the profiles by query parameters

  • {server-url}/api/v2/tenants/{tenantId}/monitoring/syslog/profiles?uuid={gatewayprofuuid}
  • {server-url}/api/v2/tenants/{tenantId}/monitoring/syslog/profiles?name={profile-name}
  • {server-url}/api/v2/tenants/{tenantId}/monitoring/syslog/profiles?id={sysloguuid}

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of tenant

Query Parameters

  • uuidstring

    Search by applicable gateway management profiles

  • namestring

    Search profiles by it's name

  • idstring

    Search by syslog profile id

Responses

  • resultsarray

  • totalResultsinteger

  • orderBystring

    Enum:
    id
  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

Create syslog profile configurations

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of tenant

Request Body

application/json

  • namestringrequired

    Profile name

  • uniqueIdstring

    Profile uuid

  • descriptionstring

    Profile description

  • managementGatewayProfilesUUIDarray of stringsrequired

    Gateway profile uuid

  • propertiesobject

    Syslog message properties to be mapped

  • syslogConfResourceFiltersarray

    Filters

Loading Examples...

Responses

  • namestring

    Profile name

  • uuidstring

    profile uuid

  • invalidRulesListarray of strings

    List of rules which are invalid for the tenant

  • codestring

    Error code

  • messagestring

    Error Message

Loading Examples...