@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Postmark Account-level API
@base https://api.postmarkapp.com/
@version 0.9.0
@common_fields {X-Postmark-Account-Token: any # The token associated with the Account on which this request will operate.}
@endpoints 23
@hint download_for_search
@toc servers(5), senders(8), domains(9), templates(1)

@group servers
@endpoint GET /servers/{serverid}
@desc Get a Server
@required {serverid: any # The ID of the Server to get.}
@returns(200) OK
@errors {422, 500}

@endpoint PUT /servers/{serverid}
@desc Edit a Server
@required {serverid: any # The ID of the Server to update.}
@optional {body: any}
@returns(200) OK
@errors {422, 500}

@endpoint DELETE /servers/{serverid}
@desc Delete a Server
@required {serverid: any # The ID of the Server that should be deleted.}
@returns(200) OK
@errors {422, 500}

@endpoint GET /servers
@desc List servers
@required {count: any # Number of servers to return per request., offset: any # Number of servers to skip.}
@optional {name: any # Filter by a specific server name}
@returns(200) OK
@errors {422, 500}

@endpoint POST /servers
@desc Create a Server
@optional {body: any}
@returns(200) OK
@errors {422, 500}

@endgroup

@group senders
@endpoint GET /senders
@desc List Sender Signatures
@required {count: any # Number of records to return per request. Max 500., offset: any # Number of records to skip}
@returns(200) OK
@errors {422, 500}

@endpoint POST /senders
@desc Create a Sender Signature
@optional {body: any}
@returns(200) OK
@errors {422, 500}

@endpoint GET /senders/{signatureid}
@desc Get a Sender Signature
@required {signatureid: any # The ID for the Sender Signature that should be retrieved.}
@returns(200) OK
@errors {422, 500}

@endpoint PUT /senders/{signatureid}
@desc Update a Sender Signature
@required {signatureid: any # The ID for the Sender Signature that should be modified by the request.}
@optional {body: any}
@returns(200) OK
@errors {422, 500}

@endpoint DELETE /senders/{signatureid}
@desc Delete a Sender Signature
@required {signatureid: any # The ID for the Sender Signature that should be deleted by the request.}
@returns(200) OK
@errors {422, 500}

@endpoint POST /senders/{signatureid}/resend
@desc Resend Signature Confirmation Email
@required {signatureid: any # The ID for the Sender Signature that should have its confirmation email resent.}
@returns(200) OK
@errors {422, 500}

@endpoint POST /senders/{signatureid}/verifyspf
@desc Request DNS Verification for SPF
@required {signatureid: any # The ID for the Sender Signature for which SPF DNS records should be verified.}
@returns(200) OK
@errors {422, 500}

@endpoint POST /senders/{signatureid}/requestnewdkim
@desc Request a new DKIM Key
@required {signatureid: any # The ID for the Sender Signature for which a new DKIM Key should be generated.}
@returns(200) OK
@errors {422, 500}

@endgroup

@group domains
@endpoint GET /domains
@desc List Domains
@required {count: any # Number of records to return per request. Max 500., offset: any # Number of records to skip}
@returns(200) OK
@errors {422, 500}

@endpoint POST /domains
@desc Create a Domain
@optional {body: any}
@returns(200) OK
@errors {422, 500}

@endpoint GET /domains/{domainid}
@desc Get a Domain
@required {domainid: any # The ID for the Domain that should be retrieved.}
@returns(200) OK
@errors {422, 500}

@endpoint PUT /domains/{domainid}
@desc Update a Domain
@required {domainid: any # The ID for the Domain that should be modified by the request.}
@optional {body: any}
@returns(200) OK
@errors {422, 500}

@endpoint DELETE /domains/{domainid}
@desc Delete a Domain
@required {domainid: any # The ID for the Domain that should be deleted by the request.}
@returns(200) OK
@errors {422, 500}

@endpoint PUT /domains/{domainid}/verifydkim
@desc Request DNS Verification for DKIM
@required {domainid: any # The ID for the Domain for which DKIM DNS records should be verified.}
@returns(200) OK
@errors {422, 500}

@endpoint PUT /domains/{domainid}/verifyreturnpath
@desc Request DNS Verification for Return-Path
@required {domainid: any # The ID for the Domain for which Return-Path DNS records should be verified.}
@returns(200) OK
@errors {422, 500}

@endpoint POST /domains/{domainid}/verifyspf
@desc Request DNS Verification for SPF
@required {domainid: any # The ID for the Domain for which SPF DNS records should be verified.}
@returns(200) OK
@errors {422, 500}

@endpoint POST /domains/{domainid}/rotatedkim
@desc Rotate DKIM Key
@required {domainid: any # The ID for the Sender Signature for which a new DKIM Key should be generated.}
@returns(200) OK
@errors {422, 500}

@endgroup

@group templates
@endpoint PUT /templates/push
@desc Push templates from one server to another
@required {body: any}
@returns(200) ok
@errors {422, 500}

@endgroup

@end