PUT /sspinstance/{uuid}

PUT /sspinstance/{uuid}

/sspinstance/{uuid}/{uuid}

Request
URI
PUT
https://{api_host}/api/sspinstance/{uuid}
COPY
Path Parameters
string
uuid
Required  

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required  

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

SspInstance object creation

SspInstance of type(s) application/json
Optional

Show optional properties

{
    "feature": "string",
    "hostname": "string",
    "name": "string",
    "status": "string"
}
{
    "_last_modified": "string",
    "avi_client_cert": "string",
    "client_cert": "string",
    "description": "string",
    "feature": "string",
    "hostname": "string",
    "ingress_cert": "string",
    "name": "string",
    "resources": {
        "avi_client_cert_ref": "string",
        "client_cert_auth_mapping_profile_ref": "string",
        "client_cert_auth_profile_ref": "string",
        "client_cert_ref": "string"
    },
    "status": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SspInstance of type(s) application/json 
{
    "_last_modified": "string",
    "avi_client_cert": "string",
    "client_cert": "string",
    "description": "string",
    "feature": "string",
    "hostname": "string",
    "ingress_cert": "string",
    "name": "string",
    "resources": {
        "avi_client_cert_ref": "string",
        "client_cert_auth_mapping_profile_ref": "string",
        "client_cert_auth_profile_ref": "string",
        "client_cert_ref": "string"
    },
    "status": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Read-Only  

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
avi_client_cert
Optional

Client certificate that Avi uses to authenticate with the SSP instance. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
client_cert
Optional

Client certificate that the SSP instance uses to authenticate with Avi. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
description
Optional

Description of the onboarded SSP feature instance. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
feature
Required  

Type of the SSP feature instance. Enum options - SSP_INTELLIGENT_ASSIST, SSP_CENTRAL_LICENSING_SERVICE. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
hostname
Required  

Hostname of the SSP feature instance. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
ingress_cert
Optional

Ingress (server) certificate chain that the SSP endpoint uses. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Required  

Name of the onboarded SSP feature instance. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
resources
Optional

resources

string
status
Required  

Status of the SSP feature instance. Enum options - SSP_STATUS_IN_PROGRESS, SSP_STATUS_ACTIVE, SSP_STATUS_CERT_UPDATE_FAILED. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant reference for the SSP object. It is a reference to an object of type Tenant. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Read-Only  

url

string
uuid
Optional

UUID for the onboarded SSP feature instance. Field introduced in 32.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

404

object not found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"feature":"string","hostname":"string","name":"string","status":"string"}' https://{api_host}/api/sspinstance/{uuid}
On This Page
Ssp Instance Operations
GET
GET /sspinstance
POST
POST /sspinstance
GET
GET /sspinstance/{uuid}
PUT
PUT /sspinstance/{uuid}
PATCH
PATCH /sspinstance/{uuid}
DELETE
DELETE /sspinstance/{uuid}