# API For Share Code ## List share code > Returns a list of share codes ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseListShareCode":{"type":"object","description":"Returns the list of share codes for the user.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","description":"Data.","properties":{"items":{"type":"array","description":"Array of share codes","items":{"$ref":"#/components/schemas/ShareCodeInfo"}},"total_items":{"type":"integer","description":"Total number of items."},"total_pages":{"type":"integer","description":"Total number of pages."}}}}},"ShareCodeInfo":{"type":"object","description":"Information about a share code.","properties":{"code":{"type":"string","description":"Share code value."},"data_type":{"type":"integer","description":"Code type: 1 = IP, 2 = traffic."},"expired_at":{"type":["integer","null"],"description":"Expiration timestamp. Null means the code does not expire."},"amount_traffic":{"type":"integer","description":"Traffic amount associated with the code (bytes)."},"forward_to":{"type":["string","null"],"description":"Email address the code was forwarded to (if configured)."},"used_by":{"type":["string","null"],"description":"Email address of the user who redeemed the code."},"number_of_ips":{"type":"integer","description":"Number of IPs associated with the code."},"status":{"$ref":"#/components/schemas/CDKeyStatus","description":"Current status of the share code."},"used_at":{"type":["integer","null"],"description":"Timestamp when the code was used."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}},"CDKeyStatus":{"type":"integer","description":"Share code status.\n0 = Available\n1 = Used\n2 = Revoked"},"ResponseBadRequestError":{"type":"object","description":"Response returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response returned when authentication fails.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/cd-keys/list-share-code":{"get":{"summary":"List share code","description":"Returns a list of share codes","parameters":[{"schema":{"type":"integer"},"name":"status","in":"query","required":false,"description":"Filter share codes by status."},{"schema":{"type":"integer"},"name":"limit","in":"query","required":false,"description":"Maximum number of items returned. Default: 30."},{"schema":{"type":"integer"},"name":"page","in":"query","required":false,"description":"Page number of the requested data. Default: 1."},{"schema":{"type":"string"},"name":"sort_by","in":"query","required":false,"description":"Field used for sorting: code, amount_ips, created_at. Default: created_at."},{"schema":{"type":"string"},"name":"order_by","in":"query","required":false,"description":"Sort order: desc or asc. Default: desc."},{"schema":{"type":"string"},"name":"keyword","in":"query","required":false,"description":"Search by keyword in the code field."},{"schema":{"type":"string"},"name":"email","in":"query","required":false,"description":"Filter codes forwarded to a specific email.\nExample: receiver@gmail.com"},{"schema":{"type":"integer"},"name":"data_type","in":"query","required":false,"description":"Filter by data type, 1: ip, 2: traffic.\nEx: 1"},{"schema":{"type":"integer"},"name":"is_enterprise","in":"query","required":false,"description":"Filter enterprise codes: 0 = false, 1 = true.\nExample: 1"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseListShareCode"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}}}}}} ``` ## List use code > Returns a list of used share codes. ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseListUseCode":{"type":"object","description":"Returns the list of redeemed share codes for the user.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","description":"Response data.","properties":{"items":{"type":"array","description":"Array of redeemed share codes.","items":{"$ref":"#/components/schemas/UseCodeInfo"}},"total_items":{"type":"integer","description":"Total number of items."},"total_pages":{"type":"integer","description":"Total number of pages."}}}}},"UseCodeInfo":{"type":"object","description":"Information about a redeemed share code.","properties":{"code":{"type":"string","description":"Share code value."},"data_type":{"type":"integer","description":"Code type: 1 = IP, 2 = traffic."},"expired_at":{"type":["integer","null"],"description":"Expiration timestamp. Null means the code does not expire."},"amount_traffic":{"type":["integer","null"],"description":"Traffic amount associated with the code (in bytes)."},"forward_to":{"type":["string","null"],"description":"Email address the code was forwarded to (if configured)."},"used_by":{"type":["string","null"],"description":"Email address of the user who redeemed the code."},"number_of_ips":{"type":"integer","description":"Number of IPs associated with the code."},"status":{"$ref":"#/components/schemas/CDKeyStatus","description":"Current status of the share code."},"used_at":{"type":["integer","null"],"description":"Timestamp when the code was used."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}},"CDKeyStatus":{"type":"integer","description":"Share code status.\n0 = Available\n1 = Used\n2 = Revoked"},"ResponseBadRequestError":{"type":"object","description":"Response returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response returned when authentication fails.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/cd-keys/list-use-code":{"get":{"summary":"List use code","description":"Returns a list of used share codes.","parameters":[{"schema":{"type":"integer"},"name":"status","in":"query","required":false,"description":"Filter by code status."},{"schema":{"type":"integer"},"name":"limit","in":"query","required":false,"description":"Maximum number of items returned. Default: 30."},{"schema":{"type":"integer"},"name":"page","in":"query","required":false,"description":"Page number of the requested data. Default: 1."},{"schema":{"type":"string"},"name":"sort_by","in":"query","required":false,"description":"Field used for sorting: code, amount_ips, used_at. Default: used_at."},{"schema":{"type":"string"},"name":"order_by","in":"query","required":false,"description":"Sort order: desc or asc. Default: desc."},{"schema":{"type":"string"},"name":"keyword","in":"query","required":false,"description":"Search by keyword in the code field."},{"schema":{"type":"string"},"name":"email","in":"query","required":false,"description":"Filter codes received from a specific email.\nExample: sender@gmail.com"},{"schema":{"type":"integer"},"name":"data_type","in":"query","required":false,"description":"Filter by data type, 1: ip, 2: traffic.\nEx: 1"},{"schema":{"type":"integer"},"name":"is_enterprise","in":"query","required":false,"description":"Filter by enterprise: 0: false, 1: true.\nEx: 1"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseListUseCode"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}}}}}} ``` ## Generate Ip share code > Generate IP share codes. ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseGenerateShareCode":{"type":"object","description":"Returns newly generated share codes.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"array","description":"Array of generated share codes.","items":{"type":"object","description":"Generated share code information.","properties":{"id":{"type":"integer","description":"ID of the generated code."},"account_id":{"type":"integer","description":"ID of the account that generated the code."},"plan":{"type":"integer","description":"Data plan type. 1 = IP plan."},"amount_ips":{"type":"integer","description":"Number of IPs associated with the code."},"code":{"type":"string","description":"Share code value."},"forward_to":{"type":["string","null"],"description":"Email address designated to receive the code."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}}}}},"ResponseBadRequestError":{"type":"object","description":"Response returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response returned when authentication fails.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/cd-keys/generate-ip-code":{"post":{"summary":"Generate Ip share code","description":"Generate IP share codes.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGenerateShareCode"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"integer","description":"Data plan type for sharing. 1 = IP plan."},"number_of_ips":{"type":"integer","description":"Number of IPs to share."},"number_of_codes":{"type":"integer","description":"Number of share codes to generate."},"forward_to":{"type":"string","description":"Email address of the recipient."}},"required":["plan","number_of_ips","number_of_codes"]}}}}}}}} ``` ## Generate Traffic share code > Generate traffic share codes. ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseGenerateShareCode":{"type":"object","description":"Returns newly generated share codes.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"array","description":"Array of generated share codes.","items":{"type":"object","description":"Generated share code information.","properties":{"id":{"type":"integer","description":"ID of the generated code."},"account_id":{"type":"integer","description":"ID of the account that generated the code."},"plan":{"type":"integer","description":"Data plan type. 1 = IP plan."},"amount_ips":{"type":"integer","description":"Number of IPs associated with the code."},"code":{"type":"string","description":"Share code value."},"forward_to":{"type":["string","null"],"description":"Email address designated to receive the code."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}}}}},"ResponseBadRequestError":{"type":"object","description":"Response returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response returned when authentication fails.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/cd-keys/generate-traffic-code":{"post":{"summary":"Generate Traffic share code","description":"Generate traffic share codes.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGenerateShareCode"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"traffic_plan":{"type":"integer","description":"ID of the traffic plan used for sharing."},"amount_traffic":{"type":"integer","description":"Amount of traffic to share in bytes. Minimum: 1000000000 (1 GB)."},"number_of_codes":{"type":"integer","description":"Number of share codes to generate."},"forward_to":{"type":"string","description":"Email address of the recipient."}},"required":["traffic_plan","number_of_ips","number_of_codes"]}}}}}}}} ``` ## Use code > Request to apply share codes. ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseUseShareCodes":{"type":"object","description":"Returns the share codes that were successfully applied.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","description":"Information about the applied codes.","properties":{"used_codes":{"type":"array","description":"Array of successfully used codes.","items":{"type":"string","description":"Applied share code."}}}}}},"ResponseBadRequestError":{"type":"object","description":"Response returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response returned when authentication fails.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/cd-keys/use-code":{"post":{"summary":"Use code","description":"Request to apply share codes.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUseShareCodes"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"codes":{"type":"array","description":"Array of share codes to apply.","items":{"type":"string","description":"Share code to apply."}}},"required":["codes"]}}}}}}}} ``` ## Revoke share code > Request to revoke share codes. ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseRevokeCodes":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","properties":{}}}},"ResponseBadRequestError":{"type":"object","description":"Response returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response returned when authentication fails.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/cd-keys/revoke-code":{"delete":{"summary":"Revoke share code","description":"Request to revoke share codes.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseRevokeCodes"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"codes":{"type":"array","description":"Array of share codes to revoke.","items":{"type":"string","description":"Share code to revoke."}}},"required":["codes"]}}}}}}}} ``` ## The CDKeyStatus object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"CDKeyStatus":{"type":"integer","description":"Share code status.\n0 = Available\n1 = Used\n2 = Revoked"}}}} ``` ## The ShareCodeInfo object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ShareCodeInfo":{"type":"object","description":"Information about a share code.","properties":{"code":{"type":"string","description":"Share code value."},"data_type":{"type":"integer","description":"Code type: 1 = IP, 2 = traffic."},"expired_at":{"type":["integer","null"],"description":"Expiration timestamp. Null means the code does not expire."},"amount_traffic":{"type":"integer","description":"Traffic amount associated with the code (bytes)."},"forward_to":{"type":["string","null"],"description":"Email address the code was forwarded to (if configured)."},"used_by":{"type":["string","null"],"description":"Email address of the user who redeemed the code."},"number_of_ips":{"type":"integer","description":"Number of IPs associated with the code."},"status":{"$ref":"#/components/schemas/CDKeyStatus","description":"Current status of the share code."},"used_at":{"type":["integer","null"],"description":"Timestamp when the code was used."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}},"CDKeyStatus":{"type":"integer","description":"Share code status.\n0 = Available\n1 = Used\n2 = Revoked"}}}} ``` ## The UseCodeInfo object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"UseCodeInfo":{"type":"object","description":"Information about a redeemed share code.","properties":{"code":{"type":"string","description":"Share code value."},"data_type":{"type":"integer","description":"Code type: 1 = IP, 2 = traffic."},"expired_at":{"type":["integer","null"],"description":"Expiration timestamp. Null means the code does not expire."},"amount_traffic":{"type":["integer","null"],"description":"Traffic amount associated with the code (in bytes)."},"forward_to":{"type":["string","null"],"description":"Email address the code was forwarded to (if configured)."},"used_by":{"type":["string","null"],"description":"Email address of the user who redeemed the code."},"number_of_ips":{"type":"integer","description":"Number of IPs associated with the code."},"status":{"$ref":"#/components/schemas/CDKeyStatus","description":"Current status of the share code."},"used_at":{"type":["integer","null"],"description":"Timestamp when the code was used."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}},"CDKeyStatus":{"type":"integer","description":"Share code status.\n0 = Available\n1 = Used\n2 = Revoked"}}}} ``` ## The ResponseListShareCode object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ResponseListShareCode":{"type":"object","description":"Returns the list of share codes for the user.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","description":"Data.","properties":{"items":{"type":"array","description":"Array of share codes","items":{"$ref":"#/components/schemas/ShareCodeInfo"}},"total_items":{"type":"integer","description":"Total number of items."},"total_pages":{"type":"integer","description":"Total number of pages."}}}}},"ShareCodeInfo":{"type":"object","description":"Information about a share code.","properties":{"code":{"type":"string","description":"Share code value."},"data_type":{"type":"integer","description":"Code type: 1 = IP, 2 = traffic."},"expired_at":{"type":["integer","null"],"description":"Expiration timestamp. Null means the code does not expire."},"amount_traffic":{"type":"integer","description":"Traffic amount associated with the code (bytes)."},"forward_to":{"type":["string","null"],"description":"Email address the code was forwarded to (if configured)."},"used_by":{"type":["string","null"],"description":"Email address of the user who redeemed the code."},"number_of_ips":{"type":"integer","description":"Number of IPs associated with the code."},"status":{"$ref":"#/components/schemas/CDKeyStatus","description":"Current status of the share code."},"used_at":{"type":["integer","null"],"description":"Timestamp when the code was used."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}},"CDKeyStatus":{"type":"integer","description":"Share code status.\n0 = Available\n1 = Used\n2 = Revoked"}}}} ``` ## The ResponseListUseCode object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ResponseListUseCode":{"type":"object","description":"Returns the list of redeemed share codes for the user.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","description":"Response data.","properties":{"items":{"type":"array","description":"Array of redeemed share codes.","items":{"$ref":"#/components/schemas/UseCodeInfo"}},"total_items":{"type":"integer","description":"Total number of items."},"total_pages":{"type":"integer","description":"Total number of pages."}}}}},"UseCodeInfo":{"type":"object","description":"Information about a redeemed share code.","properties":{"code":{"type":"string","description":"Share code value."},"data_type":{"type":"integer","description":"Code type: 1 = IP, 2 = traffic."},"expired_at":{"type":["integer","null"],"description":"Expiration timestamp. Null means the code does not expire."},"amount_traffic":{"type":["integer","null"],"description":"Traffic amount associated with the code (in bytes)."},"forward_to":{"type":["string","null"],"description":"Email address the code was forwarded to (if configured)."},"used_by":{"type":["string","null"],"description":"Email address of the user who redeemed the code."},"number_of_ips":{"type":"integer","description":"Number of IPs associated with the code."},"status":{"$ref":"#/components/schemas/CDKeyStatus","description":"Current status of the share code."},"used_at":{"type":["integer","null"],"description":"Timestamp when the code was used."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}},"CDKeyStatus":{"type":"integer","description":"Share code status.\n0 = Available\n1 = Used\n2 = Revoked"}}}} ``` ## The ResponseGenerateShareCode object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ResponseGenerateShareCode":{"type":"object","description":"Returns newly generated share codes.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"array","description":"Array of generated share codes.","items":{"type":"object","description":"Generated share code information.","properties":{"id":{"type":"integer","description":"ID of the generated code."},"account_id":{"type":"integer","description":"ID of the account that generated the code."},"plan":{"type":"integer","description":"Data plan type. 1 = IP plan."},"amount_ips":{"type":"integer","description":"Number of IPs associated with the code."},"code":{"type":"string","description":"Share code value."},"forward_to":{"type":["string","null"],"description":"Email address designated to receive the code."},"created_at":{"type":"integer","description":"Timestamp when the code was created."}}}}}}}}} ``` ## The ResponseUseShareCodes object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ResponseUseShareCodes":{"type":"object","description":"Returns the share codes that were successfully applied.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","description":"Information about the applied codes.","properties":{"used_codes":{"type":"array","description":"Array of successfully used codes.","items":{"type":"string","description":"Applied share code."}}}}}}}}} ``` ## The ResponseRevokeCodes object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ResponseRevokeCodes":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"result":{"type":"object","properties":{}}}}}}} ``` ## The ResponseForbiddenError object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ResponseForbiddenError":{"type":"object","description":"Response returned when authentication fails.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}}} ``` ## The ResponseBadRequestError object ```json {"openapi":"3.1.1","info":{"title":"CD Key","version":"1.0"},"components":{"schemas":{"ResponseBadRequestError":{"type":"object","description":"Response returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.9proxy.com/developers/public-api/api-for-share-code.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.