swagger: '2.0'
info:
  description: Configuration for NetScaler SSLvserver Information resource.
  version: 'v2'
  title: ns_sslvserver
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_sslvserver
    description: NetScaler SSLvserver Information
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key
   required: true
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/ns_sslvserver:
    get:
      tags:
        - ns_sslvserver
      summary: GET all ns_sslvserver
      operationId: getall_ns_sslvserver
      description: Use this operation to get Vserver Information
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the ns_sslvserver resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the ns_sslvserver resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of ns_sslvserver resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_sslvserver
          schema: 
              $ref: '#/definitions/getns_sslvserversResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

  /massvc/{customerid}/nitro/v2/config/ns_sslvserver/{id}:
    get:
      tags:
        - ns_sslvserver
      summary: GET by key for ns_sslvserver
      operationId: getbykey_ns_sslvserver
      description: Use this operation to get Vserver Information
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
      responses:
        200:
          description:  for ns_sslvserver
          schema: 
              $ref: '#/definitions/getns_sslvserverResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

    post:
      tags:
        - ns_sslvserver
      summary: POST operation with actions for ns_sslvserver
      operationId: post_ns_sslvserver_actions
      description: POST operation with actions for ns_sslvserver
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: action
          type: string
          required: true
          enum: [enable,poll,disable]
          description: >
            actions:
              * `enable` - Use this operation to enable the Vserver
              * `poll` - Use this operation to poll the Vserver
              * `disable` - Use this operation to disable the Vserver

        - in: body
          name: ns_sslvserver
          description: ns_sslvserver object
          schema:
              $ref: '#/definitions/addns_sslvserverRequest'
      responses:
        200:
          description: disable for ns_sslvserver
          schema: 
              $ref: '#/definitions/addns_sslvserverResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  addns_sslvserverRequest:
    type: object
    required:
      - ns_sslvserver
    properties:
      ns_sslvserver:
        $ref: '#/definitions/ns_sslvserver_readwrite'
    title: addns_sslvserverRequest
    example:
      ns_sslvserver:
        denysslreneg: "string_value"
        sessionticketkeyrefresh: "string_value"
        quantumsize: "integer_value"
        cipherurl: "string_value"
        ns_ip_address: "1.1.1.1"
        ssltriggertimeout: "integer_value"
        pushflag: "integer_value"
        allowextendedmastersecret: "string_value"
        commonname: "default GPNZIS"
        ssllogprofile: "string_value"
        name: "www.citrix.com"
        dhcount: "integer_value"
        tls13sessionticketsperauthcontext: "integer_value"
        pushenctriggertimeout: "integer_value"
        dh: "false"
        hsts: "false"
        serverauth: "string_value"
        tls13: "false"
        snienable: "string_value"
        sslinterception: "string_value"
        cipherredirect: "string_value"
        strictsigdigestcheck: "false"
        sslimaxsessperserver: "integer_value"
        clientcert: "string_value"
        prevsessionkeylifetime: "integer_value"
        sessionticketlifetime: "integer_value"
        dhfile: "string_value"
        managed: "false"
        encrypttriggerpktcount: "integer_value"
        ssl2: "false"
        sslredirect: "string_value"
        insertionencoding: "string_value"
        ersa: "false"
        strictcachecks: "string_value"
        sslireneg: "string_value"
        redirectportrewrite: "string_value"
        sessreuse: "string_value"
        ssl3: "false"
        sessionticketkeydata: "string_value"
        sessionticket: "string_value"
        cleartextport: "string_value"
        alpnprotocol: "string_value"
        clientauthuseboundcachain: "string_value"
        dhekeyexchangewithpsk: "string_value"
        ocspstapling: "string_value"
        ersacount: "integer_value"
        snihttphostmatch: "string_value"
        preload: "string_value"
        sesstimeout: "integer_value"
        sendclosenotify: "string_value"
        tls11: "false"
        skipclientcertpolicycheck: "string_value"
        dropreqwithnohostheader: "string_value"
        maxage: "integer_value"
        sessionkeylifetime: "integer_value"
        tls12: "false"
        includesubdomains: "false"
        tls10: "false"
        dhkeyexpsizelimit: "string_value"
        ssliocspcheck: "string_value"
        pushenctrigger: "string_value"
        clientauth: "string_value"
        zerorttearlydata: "string_value"

  addns_sslvserverResponse:
    type: object
    required:
      - ns_sslvserver
    properties:
      ns_sslvserver:
        $ref: '#/definitions/ns_sslvserver'
    title: addns_sslvserverResponse
    example:
      ns_sslvserver:
        denysslreneg: "string_value"
        sessionticketkeyrefresh: "string_value"
        quantumsize: "integer_value"
        cipherurl: "string_value"
        ns_ip_address: "1.1.1.1"
        ssltriggertimeout: "integer_value"
        vsvr_type: "string_value"
        pushflag: "integer_value"
        allowextendedmastersecret: "string_value"
        commonname: "default GPNZIS"
        ssllogprofile: "string_value"
        name: "www.citrix.com"
        dhcount: "integer_value"
        tls13sessionticketsperauthcontext: "integer_value"
        pushenctriggertimeout: "integer_value"
        dh: "false"
        hsts: "false"
        sslprofile: "string_value"
        serverauth: "string_value"
        tls13: "false"
        snienable: "string_value"
        sslinterception: "string_value"
        cipherredirect: "string_value"
        strictsigdigestcheck: "false"
        sslimaxsessperserver: "integer_value"
        clientcert: "string_value"
        vsvr_port: "integer_value"
        prevsessionkeylifetime: "integer_value"
        sessionticketlifetime: "integer_value"
        dhfile: "string_value"
        managed: "false"
        encrypttriggerpktcount: "integer_value"
        ssl2: "false"
        sslredirect: "string_value"
        insertionencoding: "string_value"
        ersa: "false"
        strictcachecks: "string_value"
        sslireneg: "string_value"
        state: "UP"
        redirectportrewrite: "string_value"
        sessreuse: "string_value"
        ssl3: "false"
        sessionticketkeydata: "string_value"
        sessionticket: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        cleartextport: "string_value"
        alpnprotocol: "string_value"
        clientauthuseboundcachain: "string_value"
        dhekeyexchangewithpsk: "string_value"
        poll_time: "1580714461"
        ocspstapling: "string_value"
        ersacount: "integer_value"
        snihttphostmatch: "string_value"
        vsvr_ip_address: "1.1.1.1"
        preload: "string_value"
        sesstimeout: "integer_value"
        sendclosenotify: "string_value"
        tls11: "false"
        skipclientcertpolicycheck: "string_value"
        dropreqwithnohostheader: "string_value"
        maxage: "integer_value"
        sessionkeylifetime: "integer_value"
        tls12: "false"
        includesubdomains: "false"
        tls10: "false"
        dhkeyexpsizelimit: "string_value"
        ssliocspcheck: "string_value"
        pushenctrigger: "string_value"
        clientauth: "string_value"
        display_name: "display_name"
        zerorttearlydata: "string_value"
        partition_name: "p1"
        protocol_type: "string_value"

  getns_sslvserverResponse:
    type: object
    required:
      - ns_sslvserver
    properties:
      ns_sslvserver:
        $ref: '#/definitions/ns_sslvserver'
    title: getns_sslvserverResponse
    example:
      ns_sslvserver:
        denysslreneg: "string_value"
        sessionticketkeyrefresh: "string_value"
        quantumsize: "integer_value"
        cipherurl: "string_value"
        ns_ip_address: "1.1.1.1"
        ssltriggertimeout: "integer_value"
        vsvr_type: "string_value"
        pushflag: "integer_value"
        allowextendedmastersecret: "string_value"
        commonname: "default GPNZIS"
        ssllogprofile: "string_value"
        name: "www.citrix.com"
        dhcount: "integer_value"
        tls13sessionticketsperauthcontext: "integer_value"
        pushenctriggertimeout: "integer_value"
        dh: "false"
        hsts: "false"
        sslprofile: "string_value"
        serverauth: "string_value"
        tls13: "false"
        snienable: "string_value"
        sslinterception: "string_value"
        cipherredirect: "string_value"
        strictsigdigestcheck: "false"
        sslimaxsessperserver: "integer_value"
        clientcert: "string_value"
        vsvr_port: "integer_value"
        prevsessionkeylifetime: "integer_value"
        sessionticketlifetime: "integer_value"
        dhfile: "string_value"
        managed: "false"
        encrypttriggerpktcount: "integer_value"
        ssl2: "false"
        sslredirect: "string_value"
        insertionencoding: "string_value"
        ersa: "false"
        strictcachecks: "string_value"
        sslireneg: "string_value"
        state: "UP"
        redirectportrewrite: "string_value"
        sessreuse: "string_value"
        ssl3: "false"
        sessionticketkeydata: "string_value"
        sessionticket: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        cleartextport: "string_value"
        alpnprotocol: "string_value"
        clientauthuseboundcachain: "string_value"
        dhekeyexchangewithpsk: "string_value"
        poll_time: "1580714461"
        ocspstapling: "string_value"
        ersacount: "integer_value"
        snihttphostmatch: "string_value"
        vsvr_ip_address: "1.1.1.1"
        preload: "string_value"
        sesstimeout: "integer_value"
        sendclosenotify: "string_value"
        tls11: "false"
        skipclientcertpolicycheck: "string_value"
        dropreqwithnohostheader: "string_value"
        maxage: "integer_value"
        sessionkeylifetime: "integer_value"
        tls12: "false"
        includesubdomains: "false"
        tls10: "false"
        dhkeyexpsizelimit: "string_value"
        ssliocspcheck: "string_value"
        pushenctrigger: "string_value"
        clientauth: "string_value"
        display_name: "display_name"
        zerorttearlydata: "string_value"
        partition_name: "p1"
        protocol_type: "string_value"

  getns_sslvserversResponse:
    type: object
    required:
      - ns_sslvserver
    properties:
      ns_sslvserver:
        type: array
        items:
          $ref: '#/definitions/ns_sslvserver'
    title: getns_sslvserversResponse
    example:
      ns_sslvserver:
        denysslreneg: "string_value"
        sessionticketkeyrefresh: "string_value"
        quantumsize: "integer_value"
        cipherurl: "string_value"
        ns_ip_address: "1.1.1.1"
        ssltriggertimeout: "integer_value"
        vsvr_type: "string_value"
        pushflag: "integer_value"
        allowextendedmastersecret: "string_value"
        commonname: "default GPNZIS"
        ssllogprofile: "string_value"
        name: "www.citrix.com"
        dhcount: "integer_value"
        tls13sessionticketsperauthcontext: "integer_value"
        pushenctriggertimeout: "integer_value"
        dh: "false"
        hsts: "false"
        sslprofile: "string_value"
        serverauth: "string_value"
        tls13: "false"
        snienable: "string_value"
        sslinterception: "string_value"
        cipherredirect: "string_value"
        strictsigdigestcheck: "false"
        sslimaxsessperserver: "integer_value"
        clientcert: "string_value"
        vsvr_port: "integer_value"
        prevsessionkeylifetime: "integer_value"
        sessionticketlifetime: "integer_value"
        dhfile: "string_value"
        managed: "false"
        encrypttriggerpktcount: "integer_value"
        ssl2: "false"
        sslredirect: "string_value"
        insertionencoding: "string_value"
        ersa: "false"
        strictcachecks: "string_value"
        sslireneg: "string_value"
        state: "UP"
        redirectportrewrite: "string_value"
        sessreuse: "string_value"
        ssl3: "false"
        sessionticketkeydata: "string_value"
        sessionticket: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        cleartextport: "string_value"
        alpnprotocol: "string_value"
        clientauthuseboundcachain: "string_value"
        dhekeyexchangewithpsk: "string_value"
        poll_time: "1580714461"
        ocspstapling: "string_value"
        ersacount: "integer_value"
        snihttphostmatch: "string_value"
        vsvr_ip_address: "1.1.1.1"
        preload: "string_value"
        sesstimeout: "integer_value"
        sendclosenotify: "string_value"
        tls11: "false"
        skipclientcertpolicycheck: "string_value"
        dropreqwithnohostheader: "string_value"
        maxage: "integer_value"
        sessionkeylifetime: "integer_value"
        tls12: "false"
        includesubdomains: "false"
        tls10: "false"
        dhkeyexpsizelimit: "string_value"
        ssliocspcheck: "string_value"
        pushenctrigger: "string_value"
        clientauth: "string_value"
        display_name: "display_name"
        zerorttearlydata: "string_value"
        partition_name: "p1"
        protocol_type: "string_value"

  ns_sslvserver_readwrite:
    type: object
    properties:
      denysslreneg:
        description: "denysslreneg"
        type: string
        format: string
      sessionticketkeyrefresh:
        description: "sessionticketkeyrefresh"
        type: string
        format: string
      quantumsize:
        description: "quantumsize"
        type: integer
        format: int32
      cipherurl:
        description: "cipherurl"
        type: string
        format: string
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      ssltriggertimeout:
        description: "ssltriggertimeout"
        type: integer
        format: int32
      pushflag:
        description: "pushflag"
        type: integer
        format: int32
      allowextendedmastersecret:
        description: "allowextendedmastersecret"
        type: string
        format: string
      commonname:
        description: "commonname"
        type: string
        format: string
      ssllogprofile:
        description: "ssllogprofile"
        type: string
        format: string
      name:
        description: "Vserver Name"
        type: string
        format: string
        minLength: 1
        maxLength: 100
      dhcount:
        description: "dhcount"
        type: integer
        format: int32
      tls13sessionticketsperauthcontext:
        description: "tls13sessionticketsperauthcontext"
        type: integer
        format: int32
      pushenctriggertimeout:
        description: "pushenctriggertimeout"
        type: integer
        format: int32
      dh:
        description: "dh"
        type: boolean
        format: boolean
      hsts:
        description: "hsts"
        type: boolean
        format: boolean
      serverauth:
        description: "serverauth"
        type: string
        format: string
      tls13:
        description: "tls13"
        type: boolean
        format: boolean
      snienable:
        description: "snienable"
        type: string
        format: string
      sslinterception:
        description: "sslinterception"
        type: string
        format: string
      cipherredirect:
        description: "cipherredirect"
        type: string
        format: string
      strictsigdigestcheck:
        description: "strictsigdigestcheck"
        type: boolean
        format: boolean
      sslimaxsessperserver:
        description: "sslimaxsessperserver"
        type: integer
        format: int32
      clientcert:
        description: "clientcert"
        type: string
        format: string
      prevsessionkeylifetime:
        description: "prevsessionkeylifetime"
        type: integer
        format: int32
      sessionticketlifetime:
        description: "sessionticketlifetime"
        type: integer
        format: int32
      dhfile:
        description: "dhfile"
        type: string
        format: string
      managed:
        description: "Managed vserver"
        type: boolean
        format: boolean
      encrypttriggerpktcount:
        description: "encrypttriggerpktcount"
        type: integer
        format: int32
      ssl2:
        description: "ssl2"
        type: boolean
        format: boolean
      sslredirect:
        description: "sslredirect"
        type: string
        format: string
      insertionencoding:
        description: "insertionencoding"
        type: string
        format: string
      ersa:
        description: "ersa"
        type: boolean
        format: boolean
      strictcachecks:
        description: "strictcachecks"
        type: string
        format: string
      sslireneg:
        description: "sslireneg"
        type: string
        format: string
      redirectportrewrite:
        description: "redirectportrewrite"
        type: string
        format: string
      sessreuse:
        description: "sessreuse"
        type: string
        format: string
      ssl3:
        description: "ssl3"
        type: boolean
        format: boolean
      sessionticketkeydata:
        description: "sessionticketkeydata"
        type: string
        format: string
      sessionticket:
        description: "sessionticket"
        type: string
        format: string
      cleartextport:
        description: "cleartextport"
        type: string
        format: string
      alpnprotocol:
        description: "alpnprotocol"
        type: string
        format: string
      clientauthuseboundcachain:
        description: "clientauthuseboundcachain"
        type: string
        format: string
      dhekeyexchangewithpsk:
        description: "dhekeyexchangewithpsk"
        type: string
        format: string
      ocspstapling:
        description: "ocspstapling"
        type: string
        format: string
      ersacount:
        description: "ersacount"
        type: integer
        format: int32
      snihttphostmatch:
        description: "snihttphostmatch"
        type: string
        format: string
      preload:
        description: "preload"
        type: string
        format: string
      sesstimeout:
        description: "sesstimeout"
        type: integer
        format: int32
      sendclosenotify:
        description: "sendclosenotify"
        type: string
        format: string
      tls11:
        description: "tls11"
        type: boolean
        format: boolean
      skipclientcertpolicycheck:
        description: "skipclientcertpolicycheck"
        type: string
        format: string
      dropreqwithnohostheader:
        description: "dropreqwithnohostheader"
        type: string
        format: string
      maxage:
        description: "maxage"
        type: integer
        format: int32
      sessionkeylifetime:
        description: "sessionkeylifetime"
        type: integer
        format: int32
      tls12:
        description: "tls12"
        type: boolean
        format: boolean
      includesubdomains:
        description: "includesubdomains"
        type: boolean
        format: boolean
      tls10:
        description: "tls10"
        type: boolean
        format: boolean
      dhkeyexpsizelimit:
        description: "dhkeyexpsizelimit"
        type: string
        format: string
      ssliocspcheck:
        description: "ssliocspcheck"
        type: string
        format: string
      pushenctrigger:
        description: "pushenctrigger"
        type: string
        format: string
      clientauth:
        description: "clientauth"
        type: string
        format: string
      zerorttearlydata:
        description: "zerorttearlydata"
        type: string
        format: string

  ns_sslvserver:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: uuid
          sslprofile:
             description: "SSL Profile Name"
             type: string
             format: string
          poll_time:
             description: "Last Polling Time"
             type: integer
             format: int32
          display_name:
             description: "Display Name"
             type: string
             format: string
          partition_name:
             description: "Partition Name"
             type: string
             format: string
      - $ref: '#/definitions/ns_sslvserver_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
