Jump to

• Request
• Response
• Examples

Create mTLS end point alias

post

/oam/services/rest/ssa/api/v1/hostalias/mtls

Request

Supported Media Types

• application/json

Body ()

mTLS end point alias configuration

Root Schema : mTLSEndpoint

Type: object

Show Source

• hostname(required): string
  Host name of the mTLS end point
• port(required): string
  Port of the mTLS end point

{
    "type":"object",
    "required":[
        "hostname",
        "port"
    ],
    "properties":{
        "hostname":{
            "type":"string",
            "description":"Host name of the mTLS end point"
        },
        "port":{
            "type":"string",
            "description":"Port of the mTLS end point"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Sucessfully created entity - mTLS Configuration, detail -

Body ()

Root Schema : mTLSEndpointResponse

Type: object

Show Source

• hostname: string
  Host name of the mTLS end point
• message: string
  Error messages
• port: string
  Port of the mTLS end point

{
    "type":"object",
    "properties":{
        "hostname":{
            "type":"string",
            "description":"Host name of the mTLS end point"
        },
        "port":{
            "type":"string",
            "description":"Port of the mTLS end point"
        },
        "message":{
            "type":"string",
            "description":"Error messages"
        }
    }
}

422 Response

Failed to create mTLS end point.

Back to Top

Examples

cURL Sample Request

curl --location --request POST 'https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/hostalias/mtls' \
--header 'Authorization: Basic dGVzdDp0ZXN0=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hostname": "hostname",
    "port": "4443"
}'

cURL Sample Response

Sucessfully created entity - MTLSConfiguration, detail - {"hostname":"hostname","port":"4443"}

Back to Top