Foundry API

<back to all web services

GenerateMachineApiKeyRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{Id}/generate-api-key
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GenerateMachineApiKeyRequest extends PostOperationTenanted<GenerateMachineApiKeyResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public GenerateMachineApiKeyRequest setId(String value) { this.id = value; return this; }
    }

    public static class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public PostOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class GenerateMachineApiKeyResponse
    {
        public ApiKey apiKey = null;
        public ResponseStatus responseStatus = null;
        
        public ApiKey getApiKey() { return apiKey; }
        public GenerateMachineApiKeyResponse setApiKey(ApiKey value) { this.apiKey = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GenerateMachineApiKeyResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ApiKey implements IIdentifiableResource
    {
        public String userId = null;
        public String description = null;
        public Date expiresUtc = null;
        public String key = null;
        public String id = null;
        
        public String getUserId() { return userId; }
        public ApiKey setUserId(String value) { this.userId = value; return this; }
        public String getDescription() { return description; }
        public ApiKey setDescription(String value) { this.description = value; return this; }
        public Date getExpiresUtc() { return expiresUtc; }
        public ApiKey setExpiresUtc(Date value) { this.expiresUtc = value; return this; }
        public String getKey() { return key; }
        public ApiKey setKey(String value) { this.key = value; return this; }
        public String getId() { return id; }
        public ApiKey setId(String value) { this.id = value; return this; }
    }

}

Java GenerateMachineApiKeyRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	organisationId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	apiKey: 
	{
		userId: String,
		description: String,
		expiresUtc: ,
		key: String,
		id: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}