> ## Documentation Index
> Fetch the complete documentation index at: https://docs.glorycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate Customized Endpoints

> Generate customized proxy endpoints with provided targeting location, session type, and sticky time.



## OpenAPI

````yaml post /go-api/v1/proxy/endpoints-custom
openapi: 3.0.1
info:
  title: GoProxy API Documentation
  description: ''
  version: 1.0.0
servers: []
security: []
tags: []
paths:
  /go-api/v1/proxy/endpoints-custom:
    post:
      tags: []
      summary: Generate Customized Endpoints
      description: >-
        Generate customized proxy endpoints with provided targeting location,
        session type, and sticky time.
      parameters:
        - name: apiKey
          in: header
          description: API key used for authentication.
          required: true
          example: ''
          schema:
            type: string
            title: apiKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyEndpointsCustomRequestBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProxyEndpointsCustomResponseModel'
          headers: {}
      deprecated: false
      security: []
components:
  schemas:
    ProxyEndpointsCustomRequestBody:
      properties:
        proxyType:
          type: integer
          title: proxyType
          description: >-
            The proxy type for the sub-account. 

            Use: 1 for Rotating Residential, 2 for Rotating Mobile, 3 for
            Rotating Datacenter.
        username:
          type: string
          title: username
          description: The username you wish to use with the proxies.
        password:
          type: string
          title: password
          description: The password for the username.
        protocol:
          type: string
          title: protocol
          description: >-
            The protocol used to generate the endpoint. Available options
            include **Endpoint:Port**, **HTTP(S)**, and **SOCKS5**. The default
            protocol is **Endpoint:Port**.
        randomLocation:
          type: boolean
          title: randomLocation
          description: >-
            Indicates whether a specific location is provided. If **true**,
            location fields (e.g., countryCode, regionName, cityName) are
            omitted. Default is **true**.
        countryCode:
          type: string
          title: countryCode
          description: >-
            The code of the country. Must be included in the body when the
            **randomLocation** field is **false**.
        regionName:
          type: string
          title: regionName
          description: The name of region that you want to specify.
        cityName:
          type: string
          title: cityName
          description: The name of city that you want to specify.
        sessionType:
          type: string
          title: sessionType
          description: >-
            The type of session you want to use. Available options are
            **Rotating** and **Sticky**. If omitted, the default value is
            **Rotating**. If **Rotating** is chosen, the **sessionTime** field
            is omitted, even if values are provided.
        sessionTime:
          type: integer
          title: sessionTime
          description: >-
            The duration of the session, in minutes. This field must be included
            when **sessionType** is **Sticky** and must be between 3 and 60
            minutes.
        count:
          type: integer
          title: count
          description: >-
            The number of endpoints you want the API to return. Must be included
            when **sessionType** is **Sticky**, and it must be between **1** and
            **50,000**. Default is **10**.
      type: object
      required:
        - proxyType
        - username
        - password
      title: ProxyEndpointsCustomRequestBody
    GetProxyEndpointsCustomResponseModel:
      type: array
      items:
        type: string
      title: GetProxyEndpointsCustomResponseModel
      example:
        - >-
          socks5://customer-testUser-country-US-session-0yt93h5o1apsf0b-time-10:testPass@proxy.goproxy.com:30000

````