Send Requests

Use these guidelines when sending requests using the Cloud Native Session Border Controller REST API.

URL Structure

Here's the URL structure for the requests:

https://<subdomain>.<domain>.com/<resource-path>

Where:

<subdomain>.<domain>.com: Host where the Cloud Native Session Border Controller is running.
<resource-path>: Relative path that defines the resource.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
`GET`	You can perform the following. Retrieve complete or a single configuration element. Retrieve specific file Retrieve meta-data of files Retrieve zip of files
`POST`	Add a new configuration element to the Cloud Native Session Border Controller. Upload a specific file
`PUT`	Update an existing configuration element in the Cloud Native Session Border Controller.
`DELETE`	You can perform the following. Delete a Cloud Native Session Border Controller configuration element. Delete a specific file Delete multiple files

Note:

Cloud Native Session Border Controller does not support DELETE method for singleton configuration elements.

Media Types

The following media types are supported by the Cloud Native Session Border Controller REST API:

application/json - This media type is used for managing configurations and files.
application/octet-stream - This media type is used for managing files.

Supported Headers

The Cloud Native Session Border Controller REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example

Header	Description	Example
`Content-Type`	Media type of the body of the request. Required for POST and PUT requests.	`Content-Type: application/json` `Content-Type: application/octet-stream`
`Authorization`	When requesting the access token, the request body should contain the credentials to access the IAM. When sending the access token, this header's value is the word "Bearer" followed by the previously returned access token.	Requesting a token: The request token can be obtained using the IAM API. Sending a token: `Authorization: Bearer <token value>`

Content-Type

Media type of the body of the request. Required for POST and PUT requests.

Content-Type: application/json
Content-Type: application/octet-stream

Authorization

When requesting the access token, the request body should contain the credentials to access the IAM.

When sending the access token, this header's value is the word "Bearer" followed by the previously returned access token.

Requesting a token: The request token can be obtained using the IAM API.

Sending a token:

Authorization: Bearer <token value>