Foundry API

GenerateMachineApiKeyRequest

The following routes are available for this service:
POST	/machines/{Id}/generate-api-key

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GenerateMachineApiKeyRequest : PostOperationTenanted<GenerateMachineApiKeyResponse>()
{
    var id:String? = null
}

open class PostOperationTenanted<TResponse> : PostOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class PostOperationUnTenanted<TResponse> : IPost
{
}

open class GenerateMachineApiKeyResponse
{
    var apiKey:ApiKey? = null
    var responseStatus:ResponseStatus? = null
}

open class ApiKey : IIdentifiableResource
{
    var userId:String? = null
    var description:String? = null
    var expiresUtc:Date? = null
    var key:String? = null
    var id:String? = null
}

Kotlin GenerateMachineApiKeyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: staging-api.foundrylab.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateMachineApiKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Id>String</Id>
</GenerateMachineApiKeyRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateMachineApiKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <ApiKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Description>String</d2p1:Description>
    <d2p1:ExpiresUtc>0001-01-01T00:00:00</d2p1:ExpiresUtc>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Key>String</d2p1:Key>
    <d2p1:UserId>String</d2p1:UserId>
  </ApiKey>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GenerateMachineApiKeyResponse>