Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Overview

Check the list of available endpoints and methods to work with sending policies using the Delivery methods API:

Endpoints and methods

Description

GET /policies see below

Lists the available sending policies in the domain.

GET /policy/{id} see below

Gets a detailed description of a specific sending policy.

POST /policies see below

Creates a new sending policy.

PUT /policies see below

Edits a sending policy.

DELETE /policies/{id} see below

Deletes a sending policy.

Endpoints and methods

GET /policies

Retrieves a list of the sending policies in the domain.

 Request

Example

Find below a request example in cURL language. This request will retrieve all the email type delivery methods in the domain that corresponds to the given token. Learn how to authorize your request in this article.

curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/delco/policies"
 Response

Check the list of available responses:

Code

Description

200

Successful response. Available sending policies retrieved.

[
  {
    "id": 284,
    "name": "default-delivery",
    "isDefault": true,
    "scheduled": {
      "days": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ],
      "from": "00:00",
      "to": "23:59"
    },
    "deliveryMethods": [
      {
        "id": 331,
        "type": "email",
        "name": "default-email"
      }
    ],
    "antiFloodingPolicy": {
      "id": 267,
      "name": "default AF"
    }
  },
  {
    "id": 1275,
    "name": "mySendingPolicy",
    "isDefault": false,
    "scheduled": {
      "days": [
        "TUESDAY",
        "THURSDAY"
      ],
      "from": "09:30",
      "to": "18:30"
    },
    "deliveryMethods": [
      {
        "id": 331,
        "type": "email",
        "name": "default-email"
      }
    ],
    "antiFloodingPolicy": {
      "id": 267,
      "name": "default AF"
    }
  },
  {
    "id": 467,
    "name": "Workweek - Support Hours",
    "isDefault": false,
    "scheduled": {
      "days": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY"
      ],
      "from": "08:00",
      "to": "20:00"
    },
    "deliveryMethods": [
      {
        "id": 331,
        "type": "email",
        "name": "default-email"
      }
    ],
    "antiFloodingPolicy": null
  }
]

400

Request error.

{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

{
  "code": 403,
  "msg": "string",
  "cid": "string"
}

GET /policy/{id}

Gets a detailed description of a specific sending policy given its ID.

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Definition

id required

integer

ID of the sending policy you want to retrieve.

How can I get the ID of a sending policy

You can use the GET /policies endpoint to get the IDs of the sending policies defined in your domain.

Example

Find below a request example in cURL language. This request will retrieve all the email type delivery methods in the domain that corresponds to the given token. Learn how to authorize your request in this article.

curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/delco/policies/123"
 Response

Check the list of available responses:

Code

Description

200

Successful response. Details of the sending policy retrieved.

{
  "id": 123,
  "name": "default-delivery",
  "isDefault": true,
  "scheduled": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ],
    "from": "00:00",
    "to": "23:59"
  },
  "deliveryMethods": [
    {
      "id": 331,
      "type": "email",
      "name": "default-email"
    }
  ],
  "antiFloodingPolicy": {
    "id": 267,
    "name": "default AF"
  }
}

400

Request error.

{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

{
  "code": 403,
  "msg": "string",
  "cid": "string"
}

POST /policies

Creates a new sending policy.

 Request

Request body

You must specify the updates you need to apply to the delivery method in the request body:

Parameter

Type

Definition

name required

string

Name of the new sending policy.

deliveryMethods required

object

Recipient of the alert, which corresponds to a delivery method created in the domain.

Define an object with the following parameters:

  • type (string) - Type of the delivery method to associate this policy with. Valid values are:

    • email

    • httpjson

    • servicedesk

    • jira

    • pushover

    • pagerduty

    • slack

    • servicenow

  • name (string) - Name of the delivery method to associate this policy with.

Note that both the delivery method type and name must exist in the corresponding domain. Otherwise, the request won’t work.

Example

"deliveryMethods": [
  "type": "email",
  "name": "my-delivery-method"
]

Visit Create and manage delivery methods to know more.

isDefault

boolean

If you set this to true, this policy will be automatically assigned to new alerts and predefined alerts that have not actively been assigned a sending policy.

antiFloodingPolicy

Frequency limit established for persistent alerts. You can choose between none, default, or one of your own creation.

Visit Create and manage delivery methods to know more.

scheduled

object

Days and hours during which alerts should be distributed. The time zone defined in the delivery method(s) selected is used to calculate times.

Define an object with the following parameters:

  • days (string) - Enter the weekdays you want the alert to be distributed. Indicate the specific days between brackets []. For example:

"days": [
    "MONDAY",
    "TUESDAY",
    "WEDNESDAY",
    "THURSDAY",
    "FRIDAY",
    "SATURDAY",
    "SUNDAY"
],

  • from - Indicate the starting time for alerts to be sent.

  • to -

Example

"scheduled": {
    "days": [
        "TUESDAY",
        "THURSDAY"
    ],
    "from": "00:00",
    "to": "23:59"
},
 Response

Check the list of available responses:

Code

Description

200

Successful response. Sending policy created.

{
  "id": 123,
  "name": "default-delivery",
  "isDefault": true,
  "scheduled": {
    "days": [
      "MONDAY",
      "TUESDAY",
      "WEDNESDAY",
      "THURSDAY",
      "FRIDAY",
      "SATURDAY",
      "SUNDAY"
    ],
    "from": "00:00",
    "to": "23:59"
  },
  "deliveryMethods": [
    {
      "id": 331,
      "type": "email",
      "name": "default-email"
    }
  ],
  "antiFloodingPolicy": {
    "id": 267,
    "name": "default AF"
  }
}

400

Request error.

{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

{
  "code": 403,
  "msg": "string",
  "cid": "string"
}

PUT/policies

Edits an existing sending policy.

DELETE /policies/{id}

Deletes a sending policy.

 Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Definition

id required

integer

ID of the sending policy you want to delete.

How can I get the ID of a sending policy

You can use the GET /policies endpoint to get the IDs of the sending policies defined in your domain.

Example

Find below a request example in cURL language. This request will delete the sending policy with ID 123 in the domain that corresponds to the given token. Learn how to authorize your request in this article.

curl -H "standAloneToken:YOUR_TOKEN" -X DELETE "https://api-us.devo.com/delco/policies/123"
 Response

Check the list of available responses:

Code

Description

200

Successful response. Sending policy deleted.

400

Request error.

{
  "code": 400,
  "msg": "string",
  "cid": "string"
}

403

Authentication required.

{
  "code": 403,
  "msg": "string",
  "cid": "string"
}
  • No labels