Introduction

This is the NetFoundry Notification Service

Overview

HTTP verbs

NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.

Verb Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

PUT

Used to update an existing resource, full updates only

PATCH

Used to update an existing resource, partial updates

DELETE

Used to delete an existing resource

HTTP status codes

NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.

Status code Usage

200 OK

The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

201 Created

The request has been fulfilled and resulted in a new resource being created.

202 Accepted

The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services.

204 No Content

The server successfully processed the request, but is not returning any content.

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

401 Unauthorized

The request lacks valid authentication credentials for the target resource.

403 Forbidden

The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

Pagination

Paginated services will accept the following optional request parameters:

Table 1. Request parameters
Path Type Optional Description

page

Integer

true

Page you want to retrieve, 0 indexed and defaults to 0.

size

Integer

true

Size of the page you want to retrieve, defaults to 1000.

sort

String

true

Properties that should be sorted by in the format property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc.

Pagination response has following structure:

Table 2. Response structure
Path Type Optional Description

content

Array[Object]

false

Actual items.

totalElements

Integer

false

Total count.

totalPages

Integer

false

Total pages with current page size.

last

Boolean

false

If this page is the last one.

numberOfElements

Integer

false

Actual size of content array (number of items).

first

Boolean

false

If this page is the first one.

sort

Object

true

Sort information object.

size

Integer

false

Requested size of the page.

number

Integer

false

Page number.

empty

booloean

false

If this page is empty.

Resources

Notification Settings

Find Notification Settings

GET /notification-settings

Authorization

This endpoint requires read action on the network resource type.

Path parameters

No parameters.

Query parameters

Supports standard paging query parameters.

Parameter Type Optional Description

id

Object

true

name

String

true

path

Object

true

pathMatch

String

true

Must be one of [settingEquals, settingIsPrefix, settingIsSuffix, settingIsPrefixExclusive, settingIsSuffixExclusive].

triggerType

Object

true

transmitterType

Object

true

ownerOrganizationId

Object

true

ownerIdentityId

Object

true

createdById

Object

true

deleted

Object

true

alarm.matchingCodes

Object

true

alarm.matchingCategories

Object

true

email.toAddresses

Object

true

Request fields

No request body.

Response fields

Path Type Optional Description

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

content

Array[Object]

true

page

Object

true

page.size

Integer

true

page.totalElements

Integer

true

page.totalPages

Integer

true

page.number

Integer

true

Hypermedia links

Path Optional Description

self

true

Embedded resources

Path Type Optional Description

id

String

true

path

Object

true

path.domainCode

String

true

path.path

Array[Object]

true

path.path[].typeCode

String

true

path.path[].id

String

true

path.encoded

String

true

Returns an encoded version of this {@link ResourcePath}, mainly intended for internal use, such as easy persistence in an opaque String value store. The returned value should not be interpreted. The encoded value can be rehydrated into a {@link ResourcePath} via the decode method.

condition

Object

true

condition.type

String

true
true

condition.notificationSettingId

String

true
true

condition.id

String

true

condition.matchingCodes

Array[String]

true

condition.matchingCategories

Array[String]

true

destination

Object

true

destination.type

String

true
true

destination.notificationSettingId

String

true
true

destination.id

String

true

destination.toEmailAddresses

Array[String]

true

name

String

true

A user defined name for this notification setting. This is intended to be a short meaningful value to ease administration by a human user. This may be empty, and there may be multiple with the same name. This value will not be null.

description

String

true

A user defined description for this notification setting. This is intended to be a long form text block in which a human administrator can make notes, or otherwise store details related to this notification setting. This may be empty. This value will not be null.

ownerOrganizationId

String

true

ownerIdentityId

String

true

createdBy

String

true

createdAt

String

true

updatedAt

String

true

deletedAt

String

true

deletedBy

String

true

Example request

$ curl 'https://gateway.production.netfoundry.io/notification/v1/notification-settings' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJRellQcl9QYkpJQjF3ZEFpQVBVaVFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZiNDkzY2RhLTAzZGQtNGRmYy1hMzFmLTgwZmNkNjRhNDMzNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkiLCJpYXQiOjE3Nzc1NDI0OTksImV4cCI6MTc3NzU0NjA5OSwiZ3JhbnRzLXN1cGVyIjoiW10iLCJncmFudHMtY3VzdG9tIjoiW10iLCJncmFudHMtcHVibGljIjoiW10iLCJncmFudHMtYWN0aW9uIjoiW3tcImlkXCI6XCIwMjY4ZjMxOC04NmUxLTQ5NWItYjQ1Yi0xZTRiOGMwZDk3NGRcIixcImxhc3RNb2RpZmllZFwiOjE3Nzc1NDI0OTl9XSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.Ru1_N1gSQ_wrJ2QU2HV_muJJfRdccMgcoLniV3eg4hRAL05YreGAsEIZ_5mmRFo2QZDvEVAHyLp7N9s3cCusev0PX_SaZW9OY69azFU4afi-XcUmGkTJjfogf1v_Z_wGQoehUTbxoyrbpgw91dxklzPxVtcGl5K1AnD0k4xsNJ7cRpTrhb_oDVE_JKFcTsT-oR7a-9OLMkqBWOPlWRZHWkmlTtBGfmDTClgzNpWIDXAkrLWTqud7c5tPDwsmjnhtt6lWMaPTmgbXzK75nxNaqcvrYRuPz8X3pvyAxTDPk_XovpLWijDipewBBHjkK_voCAE0zDZdP9IfEPu2FHZisQ'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 10872

{
  "_embedded" : {
    "notificationSettingList" : [ {
      "id" : "0c94a346-578d-444d-b0ff-15cd72eedcaa",
      "path" : {
        "domainCode" : "io.netfoundry.network",
        "path" : [ {
          "typeCode" : "network-group",
          "id" : "c58109eb-c455-49be-87d0-d9e506327f73"
        } ],
        "encoded" : "io.netfoundry.network:network-group:c58109eb-c455-49be-87d0-d9e506327f73"
      },
      "condition" : {
        "type" : "Alarm",
        "id" : "552026a3-d2e9-4340-abb1-a6d987913b0a",
        "notificationSettingId" : "0c94a346-578d-444d-b0ff-15cd72eedcaa",
        "matchingCodes" : [ ],
        "matchingCategories" : [ ]
      },
      "destination" : {
        "type" : "Email",
        "id" : "50d66654-1a88-4b42-8f90-848ad48089b1",
        "notificationSettingId" : "0c94a346-578d-444d-b0ff-15cd72eedcaa",
        "toEmailAddresses" : [ "dummy@email.com" ]
      },
      "name" : "Test Notification X",
      "description" : "",
      "ownerOrganizationId" : "440a20a5-5740-40bf-8e79-be468fe9faa8",
      "ownerIdentityId" : "440a20a5-5740-40bf-8e79-be468fe9faa8",
      "createdBy" : "440a20a5-5740-40bf-8e79-be468fe9faa8",
      "createdAt" : "2026-04-30T09:48:19.138614Z",
      "updatedAt" : "2026-04-30T09:48:19.138614Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/0c94a346-578d-444d-b0ff-15cd72eedcaa"
        }
      }
    }, {
      "id" : "2e9735dc-44e3-4c77-86be-a43a0a72d4ab",
      "path" : {
        "domainCode" : "io.netfoundry.network",
        "path" : [ {
          "typeCode" : "network-group",
          "id" : "f2a9d0c9-f4ac-4c67-824f-5aa8b4ab7750"
        } ],
        "encoded" : "io.netfoundry.network:network-group:f2a9d0c9-f4ac-4c67-824f-5aa8b4ab7750"
      },
      "condition" : {
        "type" : "Alarm",
        "id" : "a3cb0738-07a0-4cbd-a197-09abc9229166",
        "notificationSettingId" : "2e9735dc-44e3-4c77-86be-a43a0a72d4ab",
        "matchingCodes" : [ ],
        "matchingCategories" : [ ]
      },
      "destination" : {
        "type" : "Email",
        "id" : "3beb498f-b01e-4175-b8a6-b48a54babf0b",
        "notificationSettingId" : "2e9735dc-44e3-4c77-86be-a43a0a72d4ab",
        "toEmailAddresses" : [ "dummy@email.com" ]
      },
      "name" : "Test Notification X",
      "description" : "",
      "ownerOrganizationId" : "0001016b-2548-4ab9-98ac-d3df1d97a2e8",
      "ownerIdentityId" : "0001016b-2548-4ab9-98ac-d3df1d97a2e8",
      "createdBy" : "0001016b-2548-4ab9-98ac-d3df1d97a2e8",
      "createdAt" : "2026-04-30T09:48:19.098641Z",
      "updatedAt" : "2026-04-30T09:48:19.098641Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/2e9735dc-44e3-4c77-86be-a43a0a72d4ab"
        }
      }
    }, {
      "id" : "3c505381-8f1a-4c25-bebb-14f32b237d0c",
      "path" : {
        "domainCode" : "io.netfoundry.network",
        "path" : [ {
          "typeCode" : "network-group",
          "id" : "275ddc1f-cfb1-4715-92c6-5f76eb36359f"
        } ],
        "encoded" : "io.netfoundry.network:network-group:275ddc1f-cfb1-4715-92c6-5f76eb36359f"
      },
      "condition" : {
        "type" : "Alarm",
        "id" : "7cb13472-ded2-4ace-b871-7aa8502830e8",
        "notificationSettingId" : "3c505381-8f1a-4c25-bebb-14f32b237d0c",
        "matchingCodes" : [ ],
        "matchingCategories" : [ ]
      },
      "destination" : {
        "type" : "Email",
        "id" : "37dbda8b-4321-409e-ac62-62adea2e06fe",
        "notificationSettingId" : "3c505381-8f1a-4c25-bebb-14f32b237d0c",
        "toEmailAddresses" : [ "dummy@email.com" ]
      },
      "name" : "Test Notification X",
      "description" : "",
      "ownerOrganizationId" : "dde6569f-abc1-45df-94d3-e67221a96001",
      "ownerIdentityId" : "dde6569f-abc1-45df-94d3-e67221a96001",
      "createdBy" : "dde6569f-abc1-45df-94d3-e67221a96001",
      "createdAt" : "2026-04-30T09:48:18.987423Z",
      "updatedAt" : "2026-04-30T09:48:18.987423Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/3c505381-8f1a-4c25-bebb-14f32b237d0c"
        }
      }
    }, {
      "id" : "554b8277-8b03-45b4-81d5-dfaa3b8fccc4",
      "path" : {
        "domainCode" : "io.netfoundry.network",
        "path" : [ {
          "typeCode" : "network-group",
          "id" : "c58109eb-c455-49be-87d0-d9e506327f73"
        }, {
          "typeCode" : "network",
          "id" : "1656a45d-a420-4ae1-99de-1bce2ac6cc7d"
        } ],
        "encoded" : "io.netfoundry.network:network-group:c58109eb-c455-49be-87d0-d9e506327f73,network:1656a45d-a420-4ae1-99de-1bce2ac6cc7d"
      },
      "condition" : {
        "type" : "Alarm",
        "id" : "1f98c45e-b992-424b-bfa9-6d9a1a7e9e33",
        "notificationSettingId" : "554b8277-8b03-45b4-81d5-dfaa3b8fccc4",
        "matchingCodes" : [ ],
        "matchingCategories" : [ ]
      },
      "destination" : {
        "type" : "Email",
        "id" : "9fa47f18-68e5-4c30-9f6f-4b5cb0407730",
        "notificationSettingId" : "554b8277-8b03-45b4-81d5-dfaa3b8fccc4",
        "toEmailAddresses" : [ "dummy@email.com" ]
      },
      "name" : "Test Notification X",
      "description" : "",
      "ownerOrganizationId" : "f6c96ce6-fece-4469-a51c-73aea8ab6046",
      "ownerIdentityId" : "f6c96ce6-fece-4469-a51c-73aea8ab6046",
      "createdBy" : "f6c96ce6-fece-4469-a51c-73aea8ab6046",
      "createdAt" : "2026-04-30T09:48:19.157544Z",
      "updatedAt" : "2026-04-30T09:48:19.157544Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/554b8277-8b03-45b4-81d5-dfaa3b8fccc4"
        }
      }
    }, {
      "id" : "8715f5ee-c689-47ca-a36c-d83aab191e00",
      "path" : {
        "domainCode" : "io.netfoundry.network",
        "path" : [ {
          "typeCode" : "network-group",
          "id" : "18b18d5d-f544-4df9-ba04-4c86c7c079dd"
        } ],
        "encoded" : "io.netfoundry.network:network-group:18b18d5d-f544-4df9-ba04-4c86c7c079dd"
      },
      "condition" : {
        "type" : "Alarm",
        "id" : "5b29972c-1ebf-462f-90eb-c3834e15cc6e",
        "notificationSettingId" : "8715f5ee-c689-47ca-a36c-d83aab191e00",
        "matchingCodes" : [ ],
        "matchingCategories" : [ ]
      },
      "destination" : {
        "type" : "Email",
        "id" : "0af34216-dcc8-40f9-8ddd-8329daf76245",
        "notificationSettingId" : "8715f5ee-c689-47ca-a36c-d83aab191e00",
        "toEmailAddresses" : [ "dummy@email.com" ]
      },
      "name" : "Test Notification XYZ",
      "description" : "This is a test notification, created for testing.",
      "ownerOrganizationId" : "175a5c34-8ec9-4d66-9c17-1e64c58943d3",
      "ownerIdentityId" : "af6c045d-6354-4537-a5dc-517fc6f681fc",
      "createdBy" : "26289894-7ce8-40a8-91c4-1cda039d9ff7",
      "createdAt" : "2026-04-30T09:48:18.738431Z",
      "updatedAt" : "2026-04-30T09:48:18.738431Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/8715f5ee-c689-47ca-a36c-d83aab191e00"
        }
      }
    }, {
      "id" : "c922ecd5-3946-4385-a31a-da0bf3365083",
      "path" : {
        "domainCode" : "io.netfoundry.network",
        "path" : [ {
          "typeCode" : "network-group",
          "id" : "f2a9d0c9-f4ac-4c67-824f-5aa8b4ab7750"
        }, {
          "typeCode" : "network",
          "id" : "737d9dc5-fb3f-4b89-9cfb-cc6d82e7c88e"
        } ],
        "encoded" : "io.netfoundry.network:network-group:f2a9d0c9-f4ac-4c67-824f-5aa8b4ab7750,network:737d9dc5-fb3f-4b89-9cfb-cc6d82e7c88e"
      },
      "condition" : {
        "type" : "Alarm",
        "id" : "70d0cdbb-8be9-43a1-b309-95f3c8252a39",
        "notificationSettingId" : "c922ecd5-3946-4385-a31a-da0bf3365083",
        "matchingCodes" : [ ],
        "matchingCategories" : [ ]
      },
      "destination" : {
        "type" : "Email",
        "id" : "762e47cf-7459-4f5c-a6ff-9798a9970416",
        "notificationSettingId" : "c922ecd5-3946-4385-a31a-da0bf3365083",
        "toEmailAddresses" : [ "dummy@email.com" ]
      },
      "name" : "Test Notification X",
      "description" : "",
      "ownerOrganizationId" : "f008a4dc-e408-4477-825f-afb873ff4645",
      "ownerIdentityId" : "f008a4dc-e408-4477-825f-afb873ff4645",
      "createdBy" : "f008a4dc-e408-4477-825f-afb873ff4645",
      "createdAt" : "2026-04-30T09:48:19.119143Z",
      "updatedAt" : "2026-04-30T09:48:19.119143Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/c922ecd5-3946-4385-a31a-da0bf3365083"
        }
      }
    }, {
      "id" : "e523d791-e621-4617-93c0-66e4b3b1a2d6",
      "path" : {
        "domainCode" : "io.netfoundry.network",
        "path" : [ {
          "typeCode" : "network-group",
          "id" : "e0f76150-93bc-4105-a26e-43591e20ace9"
        } ],
        "encoded" : "io.netfoundry.network:network-group:e0f76150-93bc-4105-a26e-43591e20ace9"
      },
      "condition" : {
        "type" : "Alarm",
        "id" : "d56527f5-4227-4b44-8c04-e4c8cc5d07f2",
        "notificationSettingId" : "e523d791-e621-4617-93c0-66e4b3b1a2d6",
        "matchingCodes" : [ ],
        "matchingCategories" : [ ]
      },
      "destination" : {
        "type" : "Email",
        "id" : "7e208f14-8d51-4157-8c74-d18c4753db25",
        "notificationSettingId" : "e523d791-e621-4617-93c0-66e4b3b1a2d6",
        "toEmailAddresses" : [ "dummy@email.com" ]
      },
      "name" : "New Name",
      "description" : "This is a test notification, created for testing.",
      "ownerOrganizationId" : "cbd1f670-e65d-4226-a15f-174ed0cf68f3",
      "ownerIdentityId" : "9e4bb63e-6b4d-4642-9b94-cdbc5b6a0638",
      "createdBy" : "f5d308f3-3ddd-46ee-9aa6-7247f5d8946a",
      "createdAt" : "2026-04-30T09:48:19.033107Z",
      "updatedAt" : "2026-04-30T09:48:19.055718Z",
      "deletedAt" : null,
      "deletedBy" : null,
      "_links" : {
        "self" : {
          "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/e523d791-e621-4617-93c0-66e4b3b1a2d6"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/notification/v1"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 7,
    "totalPages" : 1,
    "number" : 0
  }
}

Get Notification Setting

GET /notification-settings/{id}

Authorization

This endpoint requires read action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

Path Type Optional Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path Optional Description

self

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/notification/v1/notification-settings/8715f5ee-c689-47ca-a36c-d83aab191e00' -i -X GET \
    -H 'Accept: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzeG1YYTJxWUhiMWpPbHlQNGcyeVhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI0NmY3NTA3LTJlMTAtNGFjNC04NjJmLTQzNTkzZDE3MmM0OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkiLCJpYXQiOjE3Nzc1NDI0OTgsImV4cCI6MTc3NzU0NjA5OCwiZ3JhbnRzLXN1cGVyIjoiW10iLCJncmFudHMtY3VzdG9tIjoiW10iLCJncmFudHMtcHVibGljIjoiW10iLCJncmFudHMtYWN0aW9uIjoiW3tcImlkXCI6XCIyZDNlOGE3Ny1hOGJiLTRhYWYtODQxZS1mMTkxNjc3ZDRhYzFcIixcImxhc3RNb2RpZmllZFwiOjE3Nzc1NDI0OTh9XSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.oNkjdbD5z7VqvuKbEo2yVROnTYvptcjhGC8pieBPQgzy4zWL1X1GGS-IDMrsuWaGWR-CUM8mZL48HSUfgxXpbveIsvIsqNdEHGAQnYnouGoU14QnoODJuCmnGpKKjCzSmqSjdAETgBInwKdDWQxGEwHFur4xv1hiEyLQ03mHKpH8Vq5hKviVVeITY_3zavm5EzA_SRsCV8ecN7217hhWD7yPZi4EiDTzzQ35Qu8lv25fIBZjm3qyw16lgSK5aQsXt8Tld369E3EyuVCSn1kTvZaZBxUoz7_vjs1X5g_BFOHzCUb_D8cvl5qVX38T9NcvAAMo7GefH3f1t72KtXaplA'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json
Content-Length: 1360

{
  "id" : "8715f5ee-c689-47ca-a36c-d83aab191e00",
  "path" : {
    "domainCode" : "io.netfoundry.network",
    "path" : [ {
      "typeCode" : "network-group",
      "id" : "18b18d5d-f544-4df9-ba04-4c86c7c079dd"
    } ],
    "encoded" : "io.netfoundry.network:network-group:18b18d5d-f544-4df9-ba04-4c86c7c079dd"
  },
  "condition" : {
    "type" : "Alarm",
    "id" : "5b29972c-1ebf-462f-90eb-c3834e15cc6e",
    "notificationSettingId" : "8715f5ee-c689-47ca-a36c-d83aab191e00",
    "matchingCodes" : [ ],
    "matchingCategories" : [ ]
  },
  "destination" : {
    "type" : "Email",
    "id" : "0af34216-dcc8-40f9-8ddd-8329daf76245",
    "notificationSettingId" : "8715f5ee-c689-47ca-a36c-d83aab191e00",
    "toEmailAddresses" : [ "dummy@email.com" ]
  },
  "name" : "Test Notification XYZ",
  "description" : "This is a test notification, created for testing.",
  "ownerOrganizationId" : "175a5c34-8ec9-4d66-9c17-1e64c58943d3",
  "ownerIdentityId" : "af6c045d-6354-4537-a5dc-517fc6f681fc",
  "createdBy" : "26289894-7ce8-40a8-91c4-1cda039d9ff7",
  "createdAt" : "2026-04-30T09:48:18.738431Z",
  "updatedAt" : "2026-04-30T09:48:18.738431Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/8715f5ee-c689-47ca-a36c-d83aab191e00"
    }
  }
}

Create Notification Setting

POST /notification-settings

Authorization

This endpoint requires update action on the network resource type.

Path parameters

No parameters.

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

description

String

true

path

Object

true

path.domainCode

String

true

path.path

Array[Object]

true

path.path[].typeCode

String

true

path.path[].id

String

true

path.encoded

String

true

Returns an encoded version of this {@link ResourcePath}, mainly intended for internal use, such as easy persistence in an opaque String value store. The returned value should not be interpreted. The encoded value can be rehydrated into a {@link ResourcePath} via the decode method.

condition

Object

true

condition.type

String

true
true

condition.notificationSettingId

String

true
true

condition.id

String

true

condition.matchingCodes

Array[String]

true

condition.matchingCategories

Array[String]

true

destination

Object

true

destination.type

String

true
true

destination.notificationSettingId

String

true
true

destination.id

String

true

destination.toEmailAddresses

Array[String]

true

ownerOrganizationId

String

true

ownerIdentityId

String

true

Response fields

Path Type Optional Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path Optional Description

self

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/notification/v1/notification-settings' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJvLWJkMXluZzZTbDdoeEplYTVOc2tnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImRkZTY1NjlmLWFiYzEtNDVkZi05NGQzLWU2NzIyMWE5NjAwMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkiLCJpYXQiOjE3Nzc1NDI0OTgsImV4cCI6MTc3NzU0NjA5OCwiZ3JhbnRzLXN1cGVyIjoiW10iLCJncmFudHMtY3VzdG9tIjoiW10iLCJncmFudHMtcHVibGljIjoiW10iLCJncmFudHMtYWN0aW9uIjoiW3tcImlkXCI6XCI2ZjY0Y2MyZC01YzJjLTRiN2YtYWNkNC1hNmU3YjBhMzZkOTRcIixcImxhc3RNb2RpZmllZFwiOjE3Nzc1NDI0OTh9XSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.EXiollF5yJUwFKBllegdoR1rvHnJ6Epz4epcVK-YzpMXfsr0kw0CYOSYXbdu9GZtj_1zIsvLb_rGzNNs55pXr2ZpzDy3kVGwplRnLaVK0micO-vvApOAwteFB3jGOr1iUeEhttMj4lxgAwJFwmgEwTAdDMyZQV1iAUiL1iwQUgY_iP057zk5v3k2DhfNCssuBBDk3wxm-b87UI9woowG628MoXWHm0-C0Wd7s0k5u8urPnrEotEw4M2IgR7XuGgAPHBa3m9Fco2JKIuRZpBFLHrICdPeYoHSUJuAjsPnzDsc1MRjauMyuICP_MlRMp1G9AjR9HrKid_ORhNKN3pAyA' \
    -d '{"name":"Test Notification X","description":"","path":{"domainCode":"io.netfoundry.network","path":[{"typeCode":"network-group","id":"275ddc1f-cfb1-4715-92c6-5f76eb36359f"}],"encoded":"io.netfoundry.network:network-group:275ddc1f-cfb1-4715-92c6-5f76eb36359f"},"condition":{"type":"Alarm","id":null,"notificationSettingId":null,"matchingCodes":[],"matchingCategories":[],"type":"Alarm"},"destination":{"type":"Email","id":null,"notificationSettingId":null,"toEmailAddresses":["dummy@email.com"],"type":"Email"},"ownerOrganizationId":null,"ownerIdentityId":null}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1309

{
  "id" : "3c505381-8f1a-4c25-bebb-14f32b237d0c",
  "path" : {
    "domainCode" : "io.netfoundry.network",
    "path" : [ {
      "typeCode" : "network-group",
      "id" : "275ddc1f-cfb1-4715-92c6-5f76eb36359f"
    } ],
    "encoded" : "io.netfoundry.network:network-group:275ddc1f-cfb1-4715-92c6-5f76eb36359f"
  },
  "condition" : {
    "type" : "Alarm",
    "id" : "7cb13472-ded2-4ace-b871-7aa8502830e8",
    "notificationSettingId" : "3c505381-8f1a-4c25-bebb-14f32b237d0c",
    "matchingCodes" : [ ],
    "matchingCategories" : [ ]
  },
  "destination" : {
    "type" : "Email",
    "id" : "37dbda8b-4321-409e-ac62-62adea2e06fe",
    "notificationSettingId" : "3c505381-8f1a-4c25-bebb-14f32b237d0c",
    "toEmailAddresses" : [ "dummy@email.com" ]
  },
  "name" : "Test Notification X",
  "description" : "",
  "ownerOrganizationId" : "dde6569f-abc1-45df-94d3-e67221a96001",
  "ownerIdentityId" : "dde6569f-abc1-45df-94d3-e67221a96001",
  "createdBy" : "dde6569f-abc1-45df-94d3-e67221a96001",
  "createdAt" : "2026-04-30T09:48:18.987423Z",
  "updatedAt" : "2026-04-30T09:48:18.987423Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/3c505381-8f1a-4c25-bebb-14f32b237d0c"
    }
  }
}

Update Notification Setting

POST /notification-settings/{id}

Authorization

This endpoint requires update action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

Path Type Optional Description

name

String

true

description

String

true

Response fields

Path Type Optional Description

content

Object

true

links

Array[Object]

true

links[].rel

String

true

links[].href

String

true

links[].hreflang

String

true

links[].media

String

true

links[].title

String

true

links[].type

String

true

links[].deprecation

String

true

links[].profile

String

true

links[].name

String

true

Hypermedia links

Path Optional Description

self

true

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/notification/v1/notification-settings/e523d791-e621-4617-93c0-66e4b3b1a2d6' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI0UTQxX1p3WEZERVVrX0ZkRWZrX3BBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjJmMTFjYzIxLWJkMDUtNGM0Yy05OWJhLWZjNThmNDg1ODIzMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkiLCJpYXQiOjE3Nzc1NDI0OTksImV4cCI6MTc3NzU0NjA5OSwiZ3JhbnRzLXN1cGVyIjoiW10iLCJncmFudHMtY3VzdG9tIjoiW10iLCJncmFudHMtcHVibGljIjoiW10iLCJncmFudHMtYWN0aW9uIjoiW3tcImlkXCI6XCJhMjljMTc4OC01NTI3LTQ4YWItOTJkMS04MWJjZDhmODcyODJcIixcImxhc3RNb2RpZmllZFwiOjE3Nzc1NDI0OTl9XSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.ERgsCLHlAklhWcJKWRgWZtHfOZdHcS61eglkWD-HLdLMFC4bkbDmsbW6MVefXrzabTLIYFIrFMEgDe-sYJ9QeDuRN9DM_1NE-6cWL8s-m_wZAqeZkOMktftLu5wZ5grFhHcWIV_FI06nCMp2AwjSfeW_7WXsh1PUXbeTGip21ha1bCGTIURMt1tU_e6YJSmDdPmy0L7FgHhAwxLDwoVcgVOLGVhZOHGAMhkNwzUZMaHZiR4ygBJVLyi8KTzJLQxtnNY4Al28zq6p2XUTT5dmL9MJ7cwHqwP89dTJCim-puXiCtGuMhKZP0_WTcp0i00hlrnYbUTbMc2bMRjLyaCEmw' \
    -d '{"name":"New Name","description":null}'

Example response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1347

{
  "id" : "e523d791-e621-4617-93c0-66e4b3b1a2d6",
  "path" : {
    "domainCode" : "io.netfoundry.network",
    "path" : [ {
      "typeCode" : "network-group",
      "id" : "e0f76150-93bc-4105-a26e-43591e20ace9"
    } ],
    "encoded" : "io.netfoundry.network:network-group:e0f76150-93bc-4105-a26e-43591e20ace9"
  },
  "condition" : {
    "type" : "Alarm",
    "id" : "d56527f5-4227-4b44-8c04-e4c8cc5d07f2",
    "notificationSettingId" : "e523d791-e621-4617-93c0-66e4b3b1a2d6",
    "matchingCodes" : [ ],
    "matchingCategories" : [ ]
  },
  "destination" : {
    "type" : "Email",
    "id" : "7e208f14-8d51-4157-8c74-d18c4753db25",
    "notificationSettingId" : "e523d791-e621-4617-93c0-66e4b3b1a2d6",
    "toEmailAddresses" : [ "dummy@email.com" ]
  },
  "name" : "New Name",
  "description" : "This is a test notification, created for testing.",
  "ownerOrganizationId" : "cbd1f670-e65d-4226-a15f-174ed0cf68f3",
  "ownerIdentityId" : "9e4bb63e-6b4d-4642-9b94-cdbc5b6a0638",
  "createdBy" : "f5d308f3-3ddd-46ee-9aa6-7247f5d8946a",
  "createdAt" : "2026-04-30T09:48:19.033107Z",
  "updatedAt" : "2026-04-30T09:48:19.055718Z",
  "deletedAt" : null,
  "deletedBy" : null,
  "_links" : {
    "self" : {
      "href" : "https://gateway.production.netfoundry.io/notification/v1/notification-settings/e523d791-e621-4617-93c0-66e4b3b1a2d6"
    }
  }
}

Delete Notification Setting

DELETE /notification-settings/{id}

Authorization

This endpoint requires update action on the network resource type.

Path parameters

Parameter Type Optional Description

id

Object

false

Query parameters

No parameters.

Request fields

No request body.

Response fields

No response body.

Hypermedia links

No links.

Embedded resources

No embedded resources.

Example request

$ curl 'https://gateway.production.netfoundry.io/notification/v1/notification-settings/4fe15f6c-7d27-4638-b154-f7a68c19ad89' -i -X DELETE \
    -H 'Content-Type: application/hal+json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJ2RGtnMmthNjU3ZHktcFRqSjZ5eHF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg1YmNjYjUzLTZhNTAtNGJjYy05ZjhiLWEyZDUwNzM3YjUyYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkiLCJpYXQiOjE3Nzc1NDI0OTgsImV4cCI6MTc3NzU0NjA5OCwiZ3JhbnRzLXN1cGVyIjoiW10iLCJncmFudHMtY3VzdG9tIjoiW10iLCJncmFudHMtcHVibGljIjoiW10iLCJncmFudHMtYWN0aW9uIjoiW3tcImlkXCI6XCIwODdiOGNlZi1hZjUyLTQ3MWEtODEzOC1kNjA4YThlMmVlMzZcIixcImxhc3RNb2RpZmllZFwiOjE3Nzc1NDI0OTh9XSIsImdyYW50cy1zdGFuZGFyZCI6IltdIn0.eaQjTijUpPhESo7wrKsh6FgVcxwwGAXL-177csbtDOp8x8C0SsRqzoZYROtuYH1VvGopEC5jyHCg8TEuQQXOSsNxZ4Hh8RjJqHIkBA2D1IX5MzAnttYtYB-Wz4TZQdFrM_XI3b02w2A_05l4noh7VXdEsVlbMrIgIVzh3NKi7hMTixgOcdod0fxMoKkk-J0ZKUqETLsqtvRVvaNZeczdvz9uYmq7E5JlKFuzlKzxe_zf9puMB2ifDpo65puWQDHdUW5GTixB-7j8PIecj68_l3T3G3s1IH5J_MQ7PNTjIzP8zajZUEEXQt2onXfKWu-Ks4eNfm9nVnTPVX9UWfRAMg'

Example response

HTTP/1.1 200 OK