Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.46 KB

POST_APIKey.md

File metadata and controls

36 lines (26 loc) · 1.46 KB

POST /APIKey

Description

POST a new APIKey file and updates the APIKey cache

  • Requires API Key: No
  • Requires System Administrator: No
  • Requires Counterpoint Registration option: Yes

Sample Request

URI

POST https://localhost:81/APIKey

Headers

  • Authorization : Basic UUFUZXN0R29sZi5NR1I6cGFzc3dvcmQx
  • APIKey : vpmk0tqApzFu5EesAMQgstBtQAEwK1ySwMZ4zwiC
  • Accept : application/json
  • Content-Type : application/json

Parameters

Name Parameter Type Data Type Required Description
APIKeyFilePath body string false The path to the new APIKey file.

Response Codes

  • 201 Created The request was successful, the customer was added to the Counterpoint database.
  • 401 Unauthorized The request could not be fulfilled. Likely due to a missing or invalid authorization header.
  • 403 Forbidden The request could not be fulfilled. Likely due to a missing, invalid, or expired APIKey, or a missing API option in the company's registration.ini
  • 500 Internal Server Error The request could not be fulfilled due to an unexpected internal error. This could be caused by a bug in the system, an unavailable database, or any other unexpected internal problem processing the request.

Error Codes

The following error codes may be returned from requests to this endpoint:

  • SUCCESS: The request was successful.