blacklistDiscovery IDD

generic_http & generic_https

Overview

This page describes the generic_http and generic_https service interface of blacklistDiscovery which enables both Application and Core/Support systems to query the blacklist entries in force that apply to them, or check if a system is blacklisted. Note that a record is in force if it is ACTIVE and not expired. This service interface is implemented using protocol, encoding as stated in the following tables:

generic_http

Profile type	type	Version
Transfer protocol	HTTP	1.1
Data encryption	N/A	-
Encoding	JSON	RFC 8259
Compression	N/A	-

generic_https

Profile type	type	Version
Transfer protocol	HTTPS	1.1
Data encryption	TLS	-
Encoding	JSON	RFC 8259
Compression	N/A	-

Hereby the Interface Design Description (IDD) is provided to the blacklistDiscovery - Service Description. For further details about how this service is meant to be used, please consult that document.

Interface Description

lookup

The requester can lookup for relevant entries that apply to them and are in force. The service operation request requires an identity related header or certificate. The requester name will be identified during authentication.

GET /blacklist/lookup HTTP/1.1
Authorization: Bearer <identity-info>

The service operation responds with the status code 200 if called successfully and with a BlacklistEntryListResponse JSON encoded body.

{
  "entries": [
    {
      "systemName": "TemperatureProvider1",
      "createdBy": "Sysop",
      "createdAt": "2025-06-05T14:15:02Z",
      "updatedAt": "2025-06-05T14:15:02Z",
      "reason": "Needs further repair.",
      "active": true
    }
  ],
  "count": 1
}

The error codes are 401 if the requester authentication was unsuccessful or 500 if an unexpected error happens. The error response also contains an ErrorResponse JSON encoded body.

{
  "errorMessage": "Invalid authorization header",
  "errorCode": 401,
  "exceptionType": "AUTH"
}

check

The requester can check whether a system is on the blacklist. The service operation request requires an identity related header or certificate and a SystemName as path parameter, which identifies the name of the system to check.

GET /blacklist/check/AlertConsumer1 HTTP/1.1
Authorization: Bearer <identity-info>

The service operation responds with the status code 200 if called successfully and a Boolean value which idicates if the system is blacklisted or not.

false

The error codes are 400 if the request is malformed, 401 if the requester authentication was unsuccessful, 403 if the requester has no permission and 500 if an unexpected error happens. The error response also contains an ErrorResponse JSON encoded body.

{
  "errorMessage": "The specified system name does not match the naming convention: AlertCon$umer1",
  "errorCode": 400,
  "exceptionType": "INVALID_PARAMETER",
  "origin": "GET /blacklist/check/AlertCon$umer1"
}