Create NF Debug Ssh Tokens

Create NF Debug Ssh Tokens

Create Kubernetes NF pod debug SSH access token for debugging purposes

Request
URI
POST
https://{api_host}/tca/proxy/api/v1/orgs/{orgId}/{orgId}/tokens/nfDebug/ssh
COPY
Path Parameters
string
orgId
Required

The identifier of the tenant

Header Parameters
boolean
X-Enable-Token-Reuse
Optional

This header signals to try to reuse an existing token with sufficient lease time instead creating a new one.


Request Body

request payload.

nfDebugSshTokenReq of type(s) application/json
Required
{
    "cnfId": "string",
    "podName": "string",
    "podNamespace": "string"
}
string
cnfId
Required

Id of the CNF to which pod belongs

string
podName
Required

Name of the pod to be debugged

string
podNamespace
Required

Namespace of the pod to be debugged

Responses
200

Successfully created NF pod debug SSH access token for debugging purposes

Returns nfDebugSshToken of type(s) application/json
{
    "id": "string",
    "cnfId": "string",
    "cnfName": "string",
    "podName": "string",
    "podNamespace": "string",
    "createdAt": "string",
    "expiresAt": "string",
    "username": "string",
    "loginUsername": "string",
    "loginPassword": "string",
    "publicKey": "string",
    "used": false
}
string
id
Required

id

string
cnfId
Required

cnfId

string
cnfName
Optional

cnfName

string
podName
Required

podName

string
podNamespace
Required

podNamespace

string As date-time As date-time
createdAt
Required

createdAt

string As date-time As date-time
expiresAt
Required

expiresAt

string
username
Required

username

string
loginUsername
Required

loginUsername

string
loginPassword
Required

loginPassword

string
publicKey
Required

publicKey

boolean
used
Required

used

Response Headers

boolean
X-Token-Reused

Has token been reused


400

Bad Request

Returns errorResponse of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

500

Internal Server Error

Returns errorResponse of type(s) application/json
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of error
errors
Optional

errors