ACOS
  • Start Here
  • How to Use this Reference
  • Resources
  • Operations
  • Example API Configuration
  • Filters
  • Batching Requests
  • Status Codes
ACOS
  • Docs »
  • slb template persist cookie
  • View page source

slb template persist cookie¶

Cookie persistence

cookie Specification¶

   
Type Collection
Object Key(s) name
Collection Name cookie-list
Collection URI /axapi/v3/slb/template/persist/cookie
Element Name cookie
Element URI /axapi/v3/slb/template/persist/cookie/{name}
Element Attributes cookie_attributes
Schema cookie schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/slb/template/persist/cookie

cookie attributes


POST /axapi/v3/slb/template/persist/cookie/
Payload:
{
    "cookie": {
        "name": "a", 
        "user-tag": "a"
    }
}

Create List

POST

/axapi/v3/slb/template/persist/cookie

cookie attributes

Get Object

GET

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes


GET /axapi/v3/slb/template/persist/cookie/a
Reponse:
{
    "cookie": {
        "name": "a", 
        "dont-honor-conn-rules": 0, 
        "expire": 31536000, 
        "insert-always": 0, 
        "encrypt-level": 1, 
        "encrypted": "B2kikkOahwIWj5EYPQdgvY3Npvjl6EAJWc8is1zPr8uWhj+M3YT2sNxQ3HEGmj+4", 
        "cookie-name": "sto-id", 
        "path": "/", 
        "pass-thru": 0, 
        "secure": 0, 
        "httponly": 0, 
        "match-type": 0, 
        "uuid": "860d7f02-5de9-11d9-8cf6-001fa00680a0", 
        "user-tag": "a", 
        "a10-url": "/axapi/v3/slb/template/persist/cookie/a"
    }
}

Get List

GET

/axapi/v3/slb/template/persist/cookie

cookie-list

Modify Object

POST

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes

Replace Object

PUT

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes


PUT /axapi/v3/slb/template/persist/cookie/a
Payload:
{
    "cookie": {
        "name": "a", 
        "user-tag": "abcd"
    }
}

Replace List

PUT

/axapi/v3/slb/template/persist/cookie

cookie-list

Delete Object

DELETE

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes


DELETE /axapi/v3/slb/template/persist/cookie/a
Reponse:
{
    "response": {
        "status": "OK"
    }
}

cookie-list¶

cookie-list is JSON List of cookie attributes

cookie-list : [

{ cookie attributes },

{ cookie attributes },

…

]

cookie attributes¶

cookie-name

Description Set cookie name (Cookie name, default “sto-id”)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: sto-id

domain

Description Set cookie domain

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

dont-honor-conn-rules

Description Do not observe connection rate rules

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

encrypt-level

Description Encryption level for cookie name / value

Type: number

Range: 0-1

Default: 1

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

expire

Description Set cookie expiration time (Expiration in seconds)

Type: number

Range: 0-31536000

Default: 31536000

httponly

Description Enable HttpOnly attribute

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

insert-always

Description Insert persist cookie to every reponse

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

match-type

Description Persist for server, default is port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description Cookie persistence (Cookie persistence template name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

pass-phrase

Description Set passphrase for encryption

Type: string

Format: password

Maximum Length: 8 characters

Maximum Length: 8 characters

Default: ACOS4KEY

pass-thru

Description Pass thru mode - Server sends the persist cookie

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

path

Description Set cookie path (Cookie path, default is “/”)

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

Default: /

prefix

Description ‘host’: the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; ‘secure’: the cookie will have been set with a Secure attribute;

Type: string

Supported Values: host, secure

samesite

Description ‘none’: none; ‘lax’: lax; ‘strict’: strict;

Type: string

Supported Values: none, lax, strict

scan-all-members

Description Persist within the same server SCAN

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secure

Description Enable secure attribute

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server

Description Persist to the same server, default is port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: server and service-group are mutually exclusive

server-service-group

Description Persist to the same server and within the same service group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-group

Description Persist within the same service group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: service-group and server are mutually exclusive

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters


© Copyright 2014-2019, a10

Built with Sphinx using a theme provided by Read the Docs.