Foundry API

<back to all web services

GenerateMachineApiKeyRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{Id}/generate-api-key
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiKey() = 
        member val UserId:String = null with get,set
        member val Description:String = null with get,set
        member val ExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Key:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type GenerateMachineApiKeyResponse() = 
        member val ApiKey:ApiKey = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GenerateMachineApiKeyRequest() = 
        inherit PostOperationTenanted<GenerateMachineApiKeyResponse>()
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationTenanted<'TResponse>() = 
        inherit PostOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# 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>