POST Add Api Key To Projects
Overview
The following table contains important information about the POST
method in regards to adding an Api Key to projects.
POST Add Api Key To Projects | |
---|---|
Method | POST |
URL or Endpoint | /api/organizations/organizationId /api-keys/projects |
Headers | Authorization |
Parameters | organizationId, api-version |
Body | Check request body below |
The description of the URL parameter is as follows:
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
organizationId | Yes | string | Unique Id of the organization. |
api-version | No | string | The correct api version to use. |
Request Body
{
"apiKeyId": 0,
"projectIds": [
"string"
]
}
Field Name | Type | Description |
---|---|---|
apiKeyId | integer | The Id of the Api Key. |
peojectIds | string | The Ids of the project. |
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": true,
"resultInfo": "string",
"statusCode": 0
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false. |
errors | array[] | Indicates if there was an error. |
messages | array[] | Returns the response message from back-end. |
result | array[Object] | Returns the response object. |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed