Cancel a Monitoring Subscription

POST 
/v1/monitoring-subscriptions/:id/cancel

Cancel a Monitoring Subscription

Request

Path Parameters

id stringrequired

Id of the Monitoring Subscription.

Responses

200

Successfully cancelled a Monitoring Subscription

application/json

Schema

Schema

data

object

idstring

Example: monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

statusstring

Possible values: [cancelled]

Example: cancelled

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z
objectstring
Example: monitoring_subscription

Example (from schema)

{
  "data": {
    "id": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "cancelled",
    "createdAt": "2020-10-13T17:46:54.000Z"
  },
  "object": "monitoring_subscription"
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

MonitoringSubscriptionAlreadyCancelled

Monitoring Subscription already cancelled

{
  "error": {
    "code": "monitoring_subscription/monitoring_subscription_already_cancelled",
    "title": "Bad request",
    "message": "Monitoring subscription is already cancelled"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

404

The specified resource was not found

application/json

Schema

Schema

error

object

codestring

Example: not_found

titlestring

Example: Resource not found

messagestring

Example: This endpoint is unavailable or can not be found

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}