Packet Host Invitations API
Manage invitations. See project endpoints to create a new invitation. Check out the product docs to learn more about [Invitations](https://metal.equinix.com/developers/docs/accounts/).
Manage invitations. See project endpoints to create a new invitation. Check out the product docs to learn more about [Invitations](https://metal.equinix.com/developers/docs/accounts/).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/packet-host-invitations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: support@equinixmetal.com
name: Equinix Metal API Team
description: '# Introduction
Equinix Metal provides a RESTful HTTP API which can be reached at .'
license:
name: Equinix Metal
url: https://metal.equinix.com/legal/
termsOfService: https://metal.equinix.com/legal/
title: Metal Invitations API
version: 1.0.0
servers:
- url: https://api.equinix.com/metal/v1
security:
- x_auth_token: []
tags:
- description: Manage invitations. See project endpoints to create a new invitation. Check out the product docs to learn more about Invitations.
name: Invitations
paths:
/invitations/{id}:
delete:
description: Decline an invitation.
operationId: declineInvitation
parameters:
- description: Invitation UUID
in: path
name: id
required: true
schema:
format: uuid
type: string
responses:
'204':
description: no content
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: not found
summary: Decline an invitation
tags:
- Invitations
get:
description: Returns a single invitation. (It include the `invitable` to maintain backward compatibility but will be removed soon)
operationId: findInvitationById
parameters:
- description: Invitation UUID
in: path
name: id
required: true
schema:
format: uuid
type: string
- description: 'Nested attributes to include. Included objects will return their full
attributes. Attribute names can be dotted (up to 3 levels) to included deeply
nested objects.'
explode: false
in: query
name: include
schema:
items:
type: string
type: array
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Invitation'
description: ok
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: not found
summary: View an invitation
tags:
- Invitations
put:
description: Accept an invitation.
operationId: acceptInvitation
parameters:
- description: Invitation UUID
in: path
name: id
required: true
schema:
format: uuid
type: string
- description: 'Nested attributes to include. Included objects will return their full
attributes. Attribute names can be dotted (up to 3 levels) to included deeply
nested objects.'
explode: false
in: query
name: include
schema:
items:
type: string
type: array
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Membership'
description: ok
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: not found
summary: Accept an invitation
tags:
- Invitations
components:
schemas:
Invitation_roles_inner:
enum:
- admin
- billing
- collaborator
- limited_collaborator
type: string
Invitation:
example:
projects:
- href: href
- href: href
updated_at: 2000-01-23 04:56:07+00:00
invitation:
href: href
organization:
href: href
roles:
- null
- null
created_at: 2000-01-23 04:56:07+00:00
href: href
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
invited_by:
href: href
nonce: nonce
invitee: invitee
properties:
created_at:
format: date-time
type: string
href:
type: string
id:
format: uuid
type: string
invitation:
$ref: '#/components/schemas/Href'
invited_by:
$ref: '#/components/schemas/Href'
invitee:
format: email
type: string
nonce:
type: string
organization:
$ref: '#/components/schemas/Href'
projects:
items:
$ref: '#/components/schemas/Href'
type: array
roles:
items:
$ref: '#/components/schemas/Invitation_roles_inner'
type: array
updated_at:
format: date-time
type: string
type: object
Membership:
example:
updated_at: 2000-01-23 04:56:07+00:00
roles:
- roles
- roles
created_at: 2000-01-23 04:56:07+00:00
project:
href: href
href: href
id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
user:
href: href
properties:
created_at:
format: date-time
type: string
href:
type: string
id:
format: uuid
type: string
project:
$ref: '#/components/schemas/Href'
roles:
items:
type: string
type: array
updated_at:
format: date-time
type: string
user:
$ref: '#/components/schemas/Href'
type: object
Href:
example:
href: href
properties:
href:
type: string
required:
- href
type: object
Error:
description: Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
properties:
error:
description: A description of the error that caused the request to fail.
type: string
errors:
description: A list of errors that contributed to the request failing.
items:
description: An error message that contributed to the request failing.
type: string
type: array
type: object
securitySchemes:
x_auth_token:
description: 'HTTP header containing the User or Project API key that will be used to authenticate the request.
'
in: header
name: X-Auth-Token
type: apiKey
x-displayName: X-Auth-Token
x-tagGroups:
- name: Accounts and Organization
tags:
- Authentication
- Emails
- Invitations
- Memberships
- Organizations
- OTPs
- PasswordResetTokens
- PaymentMethods
- Projects
- SSHKeys
- SupportRequest
- TransferRequests
- TwoFactorAuth
- Users
- UserVerificationTokens
- name: Services and Billing
tags:
- Events
- Facilities
- Incidents
- Invoices
- Licenses
- Metros
- Plans
- Usages
- name: Servers
tags:
- Devices
- Batches
- Capacity
- HardwareReservations
- OperatingSystems
- Ports
- SelfServiceReservations
- SpotMarket
- Userdata
- Volumes
- name: Networking
tags:
- BGP
- Interconnections
- IPAddresses
- MetalGateways
- VLANs
- VRFs