Get an account's architecture
One region of the account laid out from what it reported: each network (VPC) with its internet gateway, peerings and subnets (public or private, and the NAT gateway a private one leaves through), what runs in each subnet, what spans the network, what sits outside any network, the security groups, and the links between them. A node lists the admin ports its security groups open to the whole internet.
Requires the identity:cloudaccount:read and catalog:resource:read scopes.
Authorization
Parameters
Path parameters
idstring requiredThe cloud account's ID.
Query parameters
regionstringThe region to lay out.regionsin the answer lists those with resources.
Responses
200
The architecture.
dataArchitectureShow Architecture properties
connection_idstringproviderstringaccount_idstringregionstringregionsarray of objectvpcsarray of objectEach network with its internet gateway, subnets, what spans it and its peerings.outsidearray of objectWhat sits in no network, such as buckets.security_groupsarray of objectlinksarray of objecttraffic,egress,internetandallowslinks between nodes.links_truncatedboolean
400
The request is not valid: a field or filter value is wrong
(VALIDATION_ERROR, with a sentence saying what), the body is not
the expected JSON or carries an unknown field (INVALID_BODY), the
cursor is not one this list gave (INVALID_CURSOR), a binding names
a service that does not exist (UNKNOWN_COMPONENT), or a PATCH
tries to change a slug (SLUG_IMMUTABLE).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The key lacks a scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
404
Nothing with this ID (or slug) exists in the organization (NOT_FOUND).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X GET 'https://evohub.io/api/v1/catalog/connections/con_7d9f1b3a5c7e9a2c4e6b8d0f2a4c6e8b/architecture' \
-H 'Authorization: Bearer <TOKEN>'
