Foundry API

<back to all web services

CreateApiKeyRequest

Requires Authentication
The following routes are available for this service:
POST/auth/apikey
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateApiKeyRequest : PostOperationUnTenanted<CreateApiKeyResponse>()
{
    var description:String? = null
    var expiresUtc:Date? = null
}

open class PostOperationUnTenanted<TResponse> : IPost
{
}

open class CreateApiKeyResponse
{
    var responseStatus:ResponseStatus? = null
    var apiKey:ApiKey? = 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 CreateApiKeyRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /auth/apikey HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"description":"String","expiresUtc":null}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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