Superloop Connect - Service DSL Stability Profile Change Request

← Back to Service DSL Stability Profile Change

Introduction

Use these endpoints to perform a service DSL Stability profile Change.

Request Lifecycle

Changing the DSL stability profile of a service can be done, as follows:

Create a service-dsl-stability-profile-change-request resource, by sending a POST request to /api/connect/services/dsl-stability-profile-changes/request with the body of the request containing the service id, and the DSL stability profile we are changing to. The response’s http status will be 201 with a blank response body. There will be a Location response header with a URL. This URL is where the request outcome can be obtained.
Make a GET request to the URL returned in 1. to retrieve the outcome of the request. While the request is in progress, the response’s http status will be 202. This means that the request has not finished yet, but will in a moment. If the request was successful a service-dsl-stability-profile-change-request resource will be returned. If the request failed a 422 will be returned with the body containing details on why it failed in the standard error format.

Please note that the conversion process itself may take a while to complete.

Request Specifications

Table 1. API Versions
Version	Header	Changes
4	X-API-VERSION=4	Initial Version
5	X-API-VERSION=5	No change
6	X-API-VERSION=6	No Change
7	X-API-VERSION=7	No Change

API Version 4, 5, 6 and 7

POST Response

Table 2. POST HTTP Status Codes
Status Code	Meaning
201	The request was created successfully
401	Bearer token is missing or invalid
404	You do not have permission to perform this task
422	There are validation errors on the request you made. Check the response body to see what fields had issues.
500	There was an unexpected error processing the request

Webhook - ServiceDslStabilityProfileChanged

The `ServiceDslStabilityProfileChanged ` notification is sent after the service has successfully been changed to the requested DSL stability profile. To find more information, click here

GET Request

Note	The URI will be given to you in the Location header of the POST request.

Table 3. GET Request
Verb	GET
URI	/api/connect/services/dsl-stability-profile-changes/requests/{id}

Table 4. GET Request Path Variables
Path Variable	Purpose
`id`	The id of the service DSL stability profile change request

Table 5. GET HTTP Request Headers
Name	Description
`Authorization`	The OAuth bearer access token
`X-API-VERSION`	The version of the endpoint you are accessing

GET Response

Table 6. GET HTTP Status Codes
Status Code	Meaning
200	The request is complete. The body contains the service-dsl-stability-profile-change resource
202	The request is in progress
401	Bearer token is missing or invalid
404	You do not have permission to perform this task
404	The id (of the service-dsl-stability-profile-change-request resource) provided does not exist
422	The service-dsl-stability-profile-change resource failed to be created. Check the response body to see why
500	There was an unexpected error processing the request
502	There was an unexpected error with one or more of the upstream services

Table 7. GET Response Body Fields
Path	Type	Description
`id`	`Number`	The Connect identifier of the service-stability-profile-change-request resource
`serviceId`	`Number`	The Connect identifier of the service
`dslStabilityProfile`	`String`	Standard \| Stable
`status`	`String`	OPEN \| IN_PROGRESS \| COMPLETED \| IN_ERROR \| IN_ERROR_RETRY
`requestedOn`	`String`	The date/time, including UTC offset, when service DSL stability profile change request was made
`requestedById`	`Number`	The Connect identifier of the user requesting the service stability profile change
`requestedByName`	`String`	The name of the user requesting the service stability profile change
`errorDetail`	`Varies`	Error details. If any

API Version 4, 5, 6 and 7 - Examples

Successful Request

A service-dsl-stability-profile-change-request resource is created by sending a POST request to /api/connect/services/dsl-stability-profile-changes/request.

POST Request

POST /api/connect/services/dsl-stability-profile-changes/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 60
Host: 360-api.superloop.com

{
  "serviceId" : 1600,
  "dslStabilityProfile" : "Stable"
}

If all required fields were provided, then the response to the request will have:

a http status of 201

Successful POST Response

HTTP/1.1 201 Created
Location: /api/connect/services/dsl-stability-profile-changes/requests/8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Once you have the URI from the Location header, poll that URI every so often by making a GET request. While service stability profile change is in progress, the GET request’s response will have a http status of 202. Keep polling the URL until it finishes, once the request is completed successfully the GET request’s response will have a http status of 200 and the status will be COMPLETED

Note	Please keep the polling to a sensible rate.

GET Request

GET /api/connect/services/dsl-stability-profile-changes/requests/8 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.com

Successful GET Response service DSL stability profile change requested

HTTP/1.1 202 Accepted
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 220

{
  "id" : 8,
  "serviceId" : 1600,
  "status" : "OPEN",
  "dslStabilityProfile" : "Stable",
  "requestedOn" : "2025-03-11T22:24:43Z",
  "requestedById" : 11001,
  "requestedByName" : "API User",
  "errorDetail" : null
}

Successful GET Response service DSL stability profile change in progress

HTTP/1.1 202 Accepted
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 227

{
  "id" : 8,
  "serviceId" : 1600,
  "status" : "IN_PROGRESS",
  "dslStabilityProfile" : "Stable",
  "requestedOn" : "2025-03-11T22:24:43Z",
  "requestedById" : 11001,
  "requestedByName" : "API User",
  "errorDetail" : null
}

Successful GET Response service DSL stability profile change completed

HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 225

{
  "id" : 8,
  "serviceId" : 1600,
  "status" : "COMPLETED",
  "dslStabilityProfile" : "Stable",
  "requestedOn" : "2025-03-11T22:24:43Z",
  "requestedById" : 11001,
  "requestedByName" : "API User",
  "errorDetail" : null
}

Successful GET Response service DSL stability profile change in error

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 422

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "validation",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.service.dsl.stability.profile.change.status.in.error",
    "message" : "Error encountered",
    "object" : "ServiceStabilityProfileChange",
    "field" : "status",
    "rejectedValue" : "IN_ERROR"
  } ],
  "timestamp" : "2025-03-11T22:24:44.607624497Z"
}

Invalid Request

If the request is invalid for any reason, a http status of 422 is returned and the body of the response will list the problems with the request.

This example is of submitting a request when there is already a stability profile change request in progress for the service.

POST Request - Service DSL Stability Profile Change Request

POST /api/connect/services/dsl-stability-profile-changes/request HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Content-Length: 60
Host: 360-api.superloop.com

{
  "serviceId" : 1900,
  "dslStabilityProfile" : "STABLE"
}

POST Response with request validation errors

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 529

{
  "httpStatusCode" : 422,
  "type" : "client.validation",
  "code" : "validation",
  "message" : "Validation error",
  "apiSubErrors" : [ {
    "code" : "constraints.service.dsl.stability.change.request.in.progress",
    "message" : "Service already has a DSL stability profile change request in progress",
    "object" : "CommonRequestServiceDslStabilityProfileChangeCommand.Service",
    "field" : "serviceDslStabilityProfileChangeRequest",
    "rejectedValue" : 1900
  } ],
  "timestamp" : "2025-03-11T22:24:45.819706728Z"
}

Bad Request

GET Request bad request

GET /api/connect/services/dsl-stability-profile-changes/requests/AAA HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.com

GET Response bad request

HTTP/1.1 400 Bad Request
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 363

{
  "httpStatusCode" : 400,
  "type" : "client.validation",
  "code" : "method.argument.type.mismatch",
  "message" : "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Integer'; nested exception is java.lang.NumberFormatException: For input string: \"AAA\"",
  "apiSubErrors" : [ ],
  "timestamp" : "2025-03-11T22:24:42.159889285Z"
}