| POST | /machines/{Id}/generate-api-key |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrganisationId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | ApiKey | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | string | No | |
| Description | form | string | No | |
| ExpiresUtc | form | DateTime? | No | |
| Key | form | string | No | |
| Id | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | ApiKey | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /machines/{Id}/generate-api-key HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"apiKey":{"userId":"String","description":"String","expiresUtc":null,"key":"String","id":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}