{ "openrpc": "1.3.2", "info": { "title": "Equinix Docs MCP Server", "version": "0.3.1", "description": "MCP tools exposed by equinix-docs-mcp-server, described as OpenRPC methods. Each method is an MCP tool: call it with the JSON-RPC request `tools/call` and params `{\"name\": \"\", \"arguments\": {}}`. API tools are generated from the Equinix OpenAPI specs and named `_`; by default the server lists only the docs tools plus `search_tools`/`get_tool_schema`/`call_tool`, and the API tools documented here are reached through them.", "license": { "name": "MIT", "url": "https://github.com/equinix-labs/equinix-docs-mcp-server/blob/main/LICENSE" } }, "externalDocs": { "description": "equinix-docs-mcp-server on GitHub", "url": "https://github.com/equinix-labs/equinix-docs-mcp-server" }, "methods": [ { "name": "access_addGrant", "summary": "Add Grant", "description": "Allows a user to add an external grant to an access policy including a managed policy. Access to this operation is\n controlled by the access policy being accessed.\n\nThe auth token's access policy must allow `action:use/addGrant`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_0e5d0ba1" } }, { "name": "grantee", "description": "An entity that can be granted an access policy", "required": true, "schema": { "$ref": "#/components/schemas/Grantee_7548b816" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": false, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_addGrantResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "grantId": { "type": "string", "pattern": "^grant:[A-Z0-9]{13}$", "description": "Uniquely identifies an access policy grant.", "example": "grant:ABCDEFGHIJ123" }, "accessPolicyId": { "$ref": "#/components/schemas/AccessPolicyId_e60f61ab" }, "accessPolicyErn": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "grantee": { "$ref": "#/components/schemas/Grantee_7548b816" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" } }, "additionalProperties": false, "type": "object", "required": [ "grantId", "accessPolicyId", "accessPolicyErn", "grantee", "createdBy", "createdAt" ], "description": "A grant associating a grantee with an access policy.", "x-fastmcp-top-level-schema": "AccessPolicyGrant" } }, "x-mcp-annotations": { "title": "Add Grant", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_createAccessPolicy", "summary": "Create Access Policy", "description": "Allows a user to create a new access policy. The access policy is created in the project identified by the\n `projectId`. An access policy contains that same data as a permission set but also includes the `grants`\n field for indicating what principals can use the access policy. Access to this operation is controlled by the project\n being accessed.\n\nThe auth token's access policy must allow `action:use/createAccessPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "tags", "description": "Additional user-controlled data about this resource.", "required": true, "schema": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." } }, { "name": "permissions", "description": "A set of permissions, each of which may be an inline permission, a permission set reference,\n or a foreign access policy reference.", "required": true, "schema": { "$ref": "#/components/schemas/Permissions_0c73f7d1" } }, { "name": "accessPolicyId", "description": "Uniquely identifies an access policy within a project.", "required": true, "schema": { "type": "string", "pattern": "^accesspolicy:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies an access policy within a project.", "example": "accesspolicy:my-policy" } }, { "name": "description", "required": false, "schema": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." } }, { "name": "intersect", "description": "Entries must appear in both the `intersect` field and the `permissions` to be in the\n results from this permission object.", "required": false, "schema": { "$ref": "#/components/schemas/Intersect" } }, { "name": "subtract", "description": "Entries in the `subtract` field are not included in the results from this permission\n object.", "required": false, "schema": { "$ref": "#/components/schemas/Subtract_46ea2c39" } }, { "name": "allowBadRefs", "description": "Indicates that the access policy should be created even if it includes\n invalid references to permission objects.", "required": false, "schema": { "type": "string", "enum": [ "additional" ], "description": "Indicates that the access policy should be created even if it includes\n invalid references to permission objects.", "example": "additional" } } ], "result": { "name": "access_createAccessPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserAccessPolicyData" } }, "x-mcp-annotations": { "title": "Create Access Policy", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_createPermissionSet", "summary": "Create Permission Set", "description": "Allows users to define a permission set object which can then be used as a reusable building block when defining\n access policies. The permission set is created in the project identified by the `projectId`. A\n permission set is conceptually a set of action/resource tuples. The set is computed based on the `permissions`,\n `intersect`, and `subtract` fields. Each of those fields is a unioned composite and are then combined by taking the\n `permissions` tuples, intersected with the `intersect` tuples, and then from that the `subtract` tuples are\n removed. Access to this operation is controlled by the project being accessed.\n\nThe auth token's access policy must allow `action:use/createPermissionSet`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-permission-set" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "tags", "description": "Additional user-controlled data about this resource.", "required": true, "schema": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." } }, { "name": "permissions", "description": "A set of permissions, each of which may be an inline permission, a permission set reference,\n or a foreign access policy reference.", "required": true, "schema": { "$ref": "#/components/schemas/Permissions_0c73f7d1" } }, { "name": "permissionSetId", "description": "Uniquely identifies a PermissionSet within a project.", "required": true, "schema": { "type": "string", "pattern": "^permissionset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a PermissionSet within a project.", "example": "permissionset:my-set" } }, { "name": "description", "required": false, "schema": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." } }, { "name": "intersect", "description": "Entries must appear in both the `intersect` field and the `permissions` to be in the\n results from this permission object.", "required": false, "schema": { "$ref": "#/components/schemas/Intersect" } }, { "name": "subtract", "description": "Entries in the `subtract` field are not included in the results from this permission\n object.", "required": false, "schema": { "$ref": "#/components/schemas/Subtract_46ea2c39" } }, { "name": "allowBadRefs", "description": "Indicates that the permission set should be created even if it includes\n invalid references to permission objects.", "required": false, "schema": { "type": "string", "enum": [ "additional" ], "description": "Indicates that the permission set should be created even if it includes\n invalid references to permission objects.", "example": "additional" } } ], "result": { "name": "access_createPermissionSetResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PermissionSet_7ed0c398" } }, "x-mcp-annotations": { "title": "Create Permission Set", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_createPolicyMask", "summary": "Create Policy Mask", "description": "Allows a project admin to create a project-scoped policy mask. The mask controls which\n managed policies and managed permission sets are available within this project.\n Access is controlled by the project.\n\nThe auth token's access policy must allow `action:use/createPolicyMask`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-policy-mask" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "tags", "description": "Additional user-controlled data about this resource.", "required": true, "schema": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." } }, { "name": "policyMaskId", "description": "Uniquely identifies a policy mask globally or within a governing project.", "required": true, "schema": { "type": "string", "pattern": "^policymask:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a policy mask globally or within a governing project.", "example": "policymask:my-mask" } }, { "name": "managedPolicies", "required": false, "schema": { "$ref": "#/components/schemas/ManagedPolicies" } }, { "name": "managedPermissionSets", "required": false, "schema": { "$ref": "#/components/schemas/ManagedPermissionSets" } }, { "name": "subtract", "required": false, "schema": { "$ref": "#/components/schemas/Subtract_d5f41db4" } }, { "name": "description", "required": false, "schema": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." } } ], "result": { "name": "access_createPolicyMaskResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_createPolicyMaskResult" } }, "x-mcp-annotations": { "title": "Create Policy Mask", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_createRoleAssignment", "summary": "Create Role Assignment", "description": "Create a new RoleAssignment, thereby granting the principal the permissions defined by the given Role.\n\nThe auth token's access policy must allow `action:use/createRoleAssignment`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-role-assignment" } ], "paramStructure": "by-name", "params": [ { "name": "principal", "description": "The principal to be assigned to a Role.", "required": true, "schema": { "type": "string", "pattern": "^principal:([0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}:_?[a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9]+)?:.{1,200}|service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49})$", "description": "The principal to be assigned to a Role.", "example": "principal:abc-123:idp:example-user" } }, { "name": "roleId", "description": "Id of the Role to be assigned to the principal.", "required": true, "schema": { "type": "string", "pattern": "^role:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Id of the Role to be assigned to the principal.", "example": "role:550e8400-e29b-41d4-a716-446655440000" } }, { "name": "assignmentScope", "description": "The scope this assignment applies to, usually a specific Project or Organization.", "required": true, "schema": { "properties": { "id": { "type": "string", "example": "07218c48-343d-43e2-9831-a2080445cd22" }, "type": { "type": "string", "description": "Type of object refered to by assignmentScope id; must be one of the types allowed by the Role", "examples": [ "PDS_ORG", "ORGANIZATION", "PROJECT", "BILLING_ACCOUNT", "SUBSCRIPTION_KEY", "PORT" ], "example": "PROJECT" }, "parent": { "properties": { "id": { "type": "string", "description": "Id the project that owns this port", "example": "07218c48-343d-43e2-9831-a2080445cd22" }, "type": { "type": "string", "enum": [ "PROJECT" ], "example": "PROJECT" } }, "additionalProperties": false, "type": "object", "required": [ "id", "type" ], "description": "When assignmentScope type is PORT, the owning project." } }, "additionalProperties": false, "type": "object", "required": [ "id", "type" ], "description": "The scope this assignment applies to, usually a specific Project or Organization." } } ], "result": { "name": "access_createRoleAssignmentResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_createRoleAssignmentResult" } }, "x-mcp-annotations": { "title": "Create Role Assignment", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_deleteAccessPolicy", "summary": "Delete Access Policy", "description": "Allows a user to delete an access policy identified by either the `accessPolicyId` or the `accessPolicyErn`\n parameter. The access policy is deleted from the project identified by the `accessPolicyErn` if provided, else in the\n project that owns the access policy being used to invoke the operation. The project must be disabled and not have any\n grants in order for it to be deleted. Access to this operation is controlled by the access policy being accessed.\n\nThe auth token's access policy must allow `action:use/deleteAccessPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "Uniquely identifies an access policy within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_80cae0a0" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_deleteAccessPolicyResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Access Policy", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_deletePermissionSet", "summary": "Delete Permission Set", "description": "Allows a user to delete a permission set identified by either the `permissionSetId` or the `permissionSetErn`\n parameter. The permission set must not be referenced by any other permission sets or access policies in order\n for it to be deleted. Access to this operation is controlled by the permission set being accessed.\n\nThe auth token's access policy must allow `action:use/deletePermissionSet`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-permission-set" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that permissionSetId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_db7dc4f4" } }, { "name": "permissionSetId", "description": "Uniquely identifies a PermissionSet within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/PermissionSetId_aebbfdbe" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_deletePermissionSetResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Permission Set", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_deletePolicyMask", "summary": "Delete Policy Mask", "description": "Allows a user to delete a project-scoped policy mask. The mask must be disabled first.\n Access is controlled by the mask.\n\nThe auth token's access policy must allow `action:use/deletePolicyMask`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-policy-mask" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that policyMaskId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_6fa8ff36" } }, { "name": "policyMaskId", "description": "Uniquely identifies a policy mask globally or within a governing project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/PolicyMaskId" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_deletePolicyMaskResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Policy Mask", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_deleteRoleAssignment", "summary": "Delete Role Assignment", "description": "Delete an existing RoleAssignment, thereby removing the permissions granted to the principal by the given Role.\n\nThe auth token's access policy must allow `action:use/deleteRoleAssignment`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-role-assignment" } ], "paramStructure": "by-name", "params": [ { "name": "roleAssignmentId", "description": "Uniquely identifies an access policy within a project.", "required": true, "schema": { "type": "string", "pattern": "^roleassignment:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Uniquely identifies an access policy within a project.", "example": "roleassignment:550e8400-e29b-41d4-a716-446655440000" } } ], "result": { "name": "access_deleteRoleAssignmentResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Role Assignment", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_disableAccessPolicy", "summary": "Disable Access Policy", "description": "Allows a user to disable an access policy identified by either the `accessPolicyId` or the `accessPolicyErn`\n parameter. The access policy is updated in the project identified by the `accessPolicyErn` if provided, else in the\n project that owns the access policy being used to invoke the operation. Disabling an access policy means that it is\n not available for users to assume via token exchange and current tokens with this access policy as their scope will\n eventually lose access. Access to this operation is controlled by the access policy being accessed.\n\nThe auth token's access policy must allow `action:use/disableAccessPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "Uniquely identifies an access policy within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_80cae0a0" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_disableAccessPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserAccessPolicyData" } }, "x-mcp-annotations": { "title": "Disable Access Policy", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_disablePolicyMask", "summary": "Disable Policy Mask", "description": "Allows a user to disable a project-scoped policy mask. A disabled mask is treated as absent\n during policy mask resolution. Access is controlled by the mask.\n\nThe auth token's access policy must allow `action:use/disablePolicyMask`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-policy-mask" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that policyMaskId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_6fa8ff36" } }, { "name": "policyMaskId", "description": "Uniquely identifies a policy mask globally or within a governing project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/PolicyMaskId" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_disablePolicyMaskResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_createPolicyMaskResult" } }, "x-mcp-annotations": { "title": "Disable Policy Mask", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_disablePrincipalPolicy", "summary": "Disable Principal Policy", "description": "Disables a principal policy in a project by user principal. Disabling a principal policy means\n it will not be available for use by the principal and will appear as if it does not exist via\n access-use APIs. Access to this operation is controlled at the project level.\n\nThe auth token's access policy must allow `action:use/disablePrincipalPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-principal-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "userPrincipal", "description": "Globally unique string identifier for a principal formatted like \"principal:...\".", "required": true, "schema": { "$ref": "#/components/schemas/Grantee_b325aced" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_disablePrincipalPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserPrincipalPolicyData" } }, "x-mcp-annotations": { "title": "Disable Principal Policy", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_enableAccessPolicy", "summary": "Enable Access Policy", "description": "Allows a user to enable an access policy identified by either the `accessPolicyId` or the `accessPolicyErn`\n parameter. The access policy is updated in the project identified by the `accessPolicyErn` if provided, else in the\n project that owns the access policy being used to invoke the operation. This reverses the effect of disabling an\n access policy. Access to this operation is controlled by the access policy being accessed.\n\nThe auth token's access policy must allow `action:use/enableAccessPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "Uniquely identifies an access policy within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_80cae0a0" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_enableAccessPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserAccessPolicyData" } }, "x-mcp-annotations": { "title": "Enable Access Policy", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_enablePolicyMask", "summary": "Enable Policy Mask", "description": "Allows a user to re-enable a disabled project-scoped policy mask.\n Access is controlled by the mask.\n\nThe auth token's access policy must allow `action:use/enablePolicyMask`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-policy-mask" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that policyMaskId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_6fa8ff36" } }, { "name": "policyMaskId", "description": "Uniquely identifies a policy mask globally or within a governing project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/PolicyMaskId" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_enablePolicyMaskResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_createPolicyMaskResult" } }, "x-mcp-annotations": { "title": "Enable Policy Mask", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_enablePrincipalPolicy", "summary": "Enable Principal Policy", "description": "Enables a principal policy in a project by user principal. This reverses the effect of\n disabling a principal policy. Access to this operation is controlled at the project level.\n\nThe auth token's access policy must allow `action:use/enablePrincipalPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-principal-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "userPrincipal", "description": "Globally unique string identifier for a principal formatted like \"principal:...\".", "required": true, "schema": { "$ref": "#/components/schemas/Grantee_b325aced" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } } ], "result": { "name": "access_enablePrincipalPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserPrincipalPolicyData" } }, "x-mcp-annotations": { "title": "Enable Principal Policy", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_getAccessPolicy", "summary": "Get Access Policy", "description": "Allows a user to retrieve the definition of an access policy identified by `accessPolicyId`.\n The access policy is retrieved from the project identified by `projectId`.\n Access to this operation is controlled by the access policy being accessed.\n\nThe auth token's access policy must allow `action:use/getAccessPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_0e5d0ba1" } } ], "result": { "name": "access_getAccessPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserAccessPolicyData" } }, "x-mcp-annotations": { "title": "Get Access Policy", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_getEffectivePermissions", "summary": "Get Effective Permissions", "description": "Returns a unified representation of the caller's permissions for a given service,\n based on the supplied access token.\n A user in possession of a valid access token is always authorized to perform this operation.\n There is no corresponding action id, because permission to perform the operation does not depend\n on the role assignments or access policy of the caller.\n\n Permissions are always returned in the context of a specific project.\n When a project id is not supplied, permissions are returned for the project containing access\n policy in the access token's scope. When the access token is not associated with an access policy,\n a project id must be specified.\n\nThe auth token's access policy must allow `action:use/getEffectivePermissions`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-misc" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "serviceId", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "required": true, "schema": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" } }, { "name": "projectErn", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "required": false, "schema": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } } ], "result": { "name": "access_getEffectivePermissionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "principalId": { "$ref": "#/components/schemas/Grantee_b325aced" }, "projectId": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" }, "serviceId": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" }, "accessPolicyIds": { "items": { "$ref": "#/components/schemas/AccessPolicyId_e60f61ab" }, "type": "array", "minItems": 1, "uniqueItems": true }, "permissions": { "items": { "properties": { "actions": { "items": { "type": "string", "pattern": "^action:(use|srv|ops)/([a-zA-Z][a-zA-Z0-9-]{0,100})$", "description": "Id of an action, unique across all aspects of its service", "example": "action:use/listPermissionSets" }, "type": "array", "uniqueItems": true, "description": "A set of actions the caller is permitted to perform." }, "resources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "type": "array", "uniqueItems": true, "description": "A specific set of resources on which the actions may be performed." }, { "properties": { "except": { "items": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "type": "array", "uniqueItems": true } }, "additionalProperties": false, "type": "object", "required": [ "except" ], "description": "A specific set of resources in this project, on which this permission block does not apply." } ] }, "metroCodes": { "anyOf": [ { "items": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "A two-letter code identifying an Equinix metro area (e.g. SV for Silicon Valley).", "example": "SV" }, "type": "array", "uniqueItems": true, "description": "A specific set of metro codes on which the actions may be performed." }, { "properties": { "except": { "items": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "A two-letter code identifying an Equinix metro area (e.g. SV for Silicon Valley).", "example": "SV" }, "type": "array", "uniqueItems": true } }, "additionalProperties": false, "type": "object", "required": [ "except" ], "description": "A specific set of metro codes on which the actions may *not* be performed. " } ] }, "ibxIds": { "anyOf": [ { "items": { "type": "string", "pattern": "^[A-Z]{2}[0-9A-Z]{1,5}x?$", "description": "Identifies an IBX data center location (e.g. SV1).", "example": "SV1" }, "type": "array", "uniqueItems": true, "description": "A specific set of ibx ids on which the actions may be performed." }, { "properties": { "except": { "items": { "type": "string", "pattern": "^[A-Z]{2}[0-9A-Z]{1,5}x?$", "description": "Identifies an IBX data center location (e.g. SV1).", "example": "SV1" }, "type": "array", "uniqueItems": true } }, "additionalProperties": false, "type": "object", "required": [ "except" ], "description": "A specific set of ibx ids on which the actions may *not* be performed. " } ] }, "cageIds": { "anyOf": [ { "items": { "type": "string", "pattern": "^[A-Z]{2}[0-9A-Z]{1,5}x?:[a-zA-Z0-9:_.-]{1,50}$", "description": "Identifies an Equinix colocation cage within an IBX (e.g. SV1:cage-1).", "example": "SV1:cage-1" }, "type": "array", "uniqueItems": true, "description": "A specific set of cage ids on which the actions may be performed." }, { "properties": { "except": { "items": { "type": "string", "pattern": "^[A-Z]{2}[0-9A-Z]{1,5}x?:[a-zA-Z0-9:_.-]{1,50}$", "description": "Identifies an Equinix colocation cage within an IBX (e.g. SV1:cage-1).", "example": "SV1:cage-1" }, "type": "array", "uniqueItems": true } }, "additionalProperties": false, "type": "object", "required": [ "except" ], "description": "A specific set of cage ids on which the actions may *not* be performed. " } ] }, "condition": { "type": "string", "description": "A Cedar policy language expression that must be true for the actions to be performed.", "example": "context.myAttribute < 5" } }, "additionalProperties": false, "type": "object", "required": [ "actions" ], "description": "The caller has permission to perform any of the given actions. The resources field, when present, indicates that the actions apply only to the referenced resources (or any *except* the referenced resources). The condition field, when present, indicates that the actions apply only when the condition is true." }, "type": "array", "uniqueItems": true } }, "additionalProperties": false, "type": "object", "required": [ "principalId", "projectId", "serviceId", "permissions" ], "description": "The effective permissions granted to a principal within a project for a service.", "x-fastmcp-top-level-schema": "EffectivePermissions" } }, "x-mcp-annotations": { "title": "Get Effective Permissions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_getPermissionSet", "summary": "Get Permission Set", "description": "Allows a user to retrieve the definition of a permission set identified by `permissionSetId`.\n The permission set is retrieved from the project identified by `projectId`.\n Access to this operation is controlled by the permission set being accessed.\n\nThe auth token's access policy must allow `action:use/getPermissionSet`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-permission-set" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that permissionSetId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_db7dc4f4" } }, { "name": "permissionSetId", "description": "\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "description": "\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "anyOf": [ { "$ref": "#/components/schemas/PermissionSetId_c6d1426e" }, { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } ] } } ], "result": { "name": "access_getPermissionSetResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PermissionSet_7ed0c398" } }, "x-mcp-annotations": { "title": "Get Permission Set", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_getPolicyMask", "summary": "Get Policy Mask", "description": "Allows a user to retrieve a project-scoped policy mask. Access is controlled by the mask.\n\nThe auth token's access policy must allow `action:use/getPolicyMask`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-policy-mask" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that policyMaskId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_6fa8ff36" } }, { "name": "policyMaskId", "description": "Uniquely identifies a policy mask globally or within a governing project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/PolicyMaskId" } } ], "result": { "name": "access_getPolicyMaskResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_createPolicyMaskResult" } }, "x-mcp-annotations": { "title": "Get Policy Mask", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_getPrincipalPolicy", "summary": "Get Principal Policy", "description": "Retrieves a principal policy in a project by user principal. Access to this operation\n is controlled at the project level. Returns nil if the policy is disabled.\n\nThe auth token's access policy must allow `action:use/getPrincipalPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-principal-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "userPrincipal", "description": "Globally unique string identifier for a principal formatted like \"principal:...\".", "required": true, "schema": { "$ref": "#/components/schemas/Grantee_b325aced" } } ], "result": { "name": "access_getPrincipalPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserPrincipalPolicyData" } }, "x-mcp-annotations": { "title": "Get Principal Policy", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_getRoleAssignment", "summary": "Get Role Assignment", "description": "Get a RoleAssignment by its id. For an Access Policy token, the\n RoleAssignment's assignmentScope must be at or below the project (if\n given, otherwise the project that owns the Access Policy) For a Role\n Assignment token, the RoleAssignment must be visible by the user and the\n project args are unsupported.\n\nThe auth token's access policy must allow `action:use/getRoleAssignment`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-role-assignment" } ], "paramStructure": "by-name", "params": [ { "name": "roleAssignmentId", "description": "Uniquely identifies an access policy within a project.", "required": true, "schema": { "type": "string", "pattern": "^roleassignment:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Uniquely identifies an access policy within a project.", "example": "roleassignment:550e8400-e29b-41d4-a716-446655440000" } } ], "result": { "name": "access_getRoleAssignmentResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_createRoleAssignmentResult" } }, "x-mcp-annotations": { "title": "Get Role Assignment", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_getServicePolicySchema", "summary": "Get Service Policy Schema", "description": "Allows a user to retrieve the Cedar schema for the given service, in JSON representation. The Cedar schema describes\n the attributes and resource types that can be referenced in access policy conditions for each action of the\n service. Access is controlled based on the project identified by `projectId`.\n\nThe auth token's access policy must allow `action:use/getServicePolicySchema`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-misc" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "serviceId", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "required": true, "schema": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" } } ], "result": { "name": "access_getServicePolicySchemaResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "schema": { "additionalProperties": {}, "type": "object" } }, "additionalProperties": false, "type": "object", "required": [ "schema" ], "description": "The policy schema for a service, as a map of field names to types.", "x-fastmcp-top-level-schema": "ServicePolicySchema" } }, "x-mcp-annotations": { "title": "Get Service Policy Schema", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listAccessPolicies", "summary": "List Access Policies", "description": "Allows a user to page through all of the access policies within a project. The project is identified by\n `projectId`. Access to this operation is controlled by the project being accessed.\n\nThe auth token's access policy must allow `action:use/listAccessPolicies`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } } ], "result": { "name": "access_listAccessPoliciesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "permissions": { "$ref": "#/components/schemas/Permissions_0c73f7d1" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "ern": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "disabledPolicy": { "enum": [ true ], "example": true }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "managed": { "enum": [ true ], "example": true }, "intersect": { "$ref": "#/components/schemas/Intersect" }, "subtract": { "$ref": "#/components/schemas/Subtract_46ea2c39" }, "accessPolicyId": { "$ref": "#/components/schemas/AccessPolicyId_e60f61ab" }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "tags", "permissions", "rev", "ern", "accessPolicyId" ], "title": "UserAccessPolicyData", "description": "A set of permissions that is granted to principals, groups, or other projects." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of access policies.", "x-fastmcp-top-level-schema": "AccessPolicyList" } }, "x-mcp-annotations": { "title": "List Access Policies", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listActionSets", "summary": "List Action Sets", "description": "Allows a user to page through the action sets defined for a given `serviceId`. This allows users to discover what\n action sets are available to be used when defining access policies. Access to this is operation is controlled by\n the project specified by `projectId`. The results are filtered according to the service mask of that same project.\n\nThe auth token's access policy must allow `action:use/listActionSets`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-misc" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "serviceId", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "required": true, "schema": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } }, { "name": "projectErn", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "required": false, "schema": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } } ], "result": { "name": "access_listActionSetsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "actionSetId": { "type": "string", "pattern": "^actionset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies an ActionSet within a Service.", "example": "actionset:myactions" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "serviceId": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "actionSet": { "items": { "type": "string", "pattern": "^action:(use|srv|ops)/([a-zA-Z][a-zA-Z0-9-]{0,100})$", "description": "Id of an action, unique across all aspects of its service", "example": "action:use/listPermissionSets" }, "type": "array", "uniqueItems": true }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "actionSet", "tags", "rev", "serviceId", "actionSetId" ], "description": "A service action set without an ERN, as returned in list operations." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of service action sets (without ERNs).", "x-fastmcp-top-level-schema": "ServiceActionSetNoErnList" } }, "x-mcp-annotations": { "title": "List Action Sets", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listActions", "summary": "List Actions", "description": "Allows a user to page through the actions defined for a given `serviceId`. This allows users to discover what actions\n are available to be used when defining access policies. Access to this is operation is controlled by\n the project specified by `projectId`. The results are filtered\n according to the service mask of that same project. The results will include actions from all of the\n aspects which are accessible based on the service mask. When the service mask does not allow any access to the\n service an exception is thrown.\n\nThe auth token's access policy must allow `action:use/listActions`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-misc" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "serviceId", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "required": true, "schema": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } }, { "name": "projectErn", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "required": false, "schema": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } } ], "result": { "name": "access_listActionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "serviceAspect": { "type": "string", "enum": [ "aspect:use", "aspect:srv", "aspect:ops" ], "description": "Identifies one of the three api aspects, \"aspect:use\", \"aspect:srv\", or \"aspect:ops\".", "example": "aspect:use" }, "rbacPermission": { "properties": { "permission": { "type": "string", "example": "fabric.port.read" }, "permissionResourceType": { "type": "string", "example": "PROJECT" } }, "additionalProperties": false, "type": "object", "required": [ "permission", "permissionResourceType" ], "description": "The action mapping to access-mgmt permissions, used when performing\nauthz via role-assignment token scope." }, "permissionCodes": { "additionalProperties": { "properties": { "requiresAll": { "type": "boolean", "description": "True indicates that the action is only allowed when the user has been unconditionally granted the permission code at the top-level of the asset hierarchy", "example": true } }, "additionalProperties": false, "type": "object" }, "type": "object" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/Attributes" }, {} ], "description": "Identify the attributes which are included on this action." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "actionId": { "type": "string", "pattern": "^action:(use|srv|ops)/([a-zA-Z][a-zA-Z0-9-]{0,100})$", "description": "Id of an action, unique across all aspects of its service", "example": "action:use/listPermissionSets" } }, "additionalProperties": false, "type": "object", "required": [ "serviceAspect", "tags", "actionId" ], "description": "A single action available on a service, including its identifier." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of actions available on a service.", "x-fastmcp-top-level-schema": "ActionList" } }, "x-mcp-annotations": { "title": "List Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listGrants", "summary": "List Grants", "description": "Allows a user to page through the external grants of an access policy including a managed policy. Access to this\n operation is controlled by the access policy being accessed.\n\nThe auth token's access policy must allow `action:use/listGrants`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_0e5d0ba1" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } } ], "result": { "name": "access_listGrantsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "grantId": { "type": "string", "pattern": "^grant:[A-Z0-9]{13}$", "description": "Uniquely identifies an access policy grant.", "example": "grant:ABCDEFGHIJ123" }, "accessPolicyId": { "$ref": "#/components/schemas/AccessPolicyId_e60f61ab" }, "accessPolicyErn": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "grantee": { "$ref": "#/components/schemas/Grantee_7548b816" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" } }, "additionalProperties": false, "type": "object", "required": [ "grantId", "accessPolicyId", "accessPolicyErn", "grantee", "createdBy", "createdAt" ], "description": "A grant associating a grantee with an access policy." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of access policy grants.", "x-fastmcp-top-level-schema": "AccessPolicyGrantList" } }, "x-mcp-annotations": { "title": "List Grants", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listPermissionSets", "summary": "List Permission Sets", "description": "Allows a user to page through all of the permission sets within a project. The project is identifed by the\n `projectId`. Access to this operation is controlled by the project being accessed.\n\nThe auth token's access policy must allow `action:use/listPermissionSets`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-permission-set" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } } ], "result": { "name": "access_listPermissionSetsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "permissions": { "$ref": "#/components/schemas/Permissions_0c73f7d1" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "ern": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "managed": { "enum": [ true ], "example": true }, "intersect": { "$ref": "#/components/schemas/Intersect" }, "subtract": { "$ref": "#/components/schemas/Subtract_46ea2c39" }, "permissionSetId": { "$ref": "#/components/schemas/PermissionSetId_c6d1426e" }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "tags", "permissions", "rev", "ern", "permissionSetId" ], "title": "PermissionSet", "description": "A named, reusable set of permissions within a project." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of permission sets.", "x-fastmcp-top-level-schema": "PermissionSetList" } }, "x-mcp-annotations": { "title": "List Permission Sets", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listPolicyMasks", "summary": "List Policy Masks", "description": "Allows a user to list project-scoped policy masks with pagination.\n Authorization is checked against the project.\n\nThe auth token's access policy must allow `action:use/listPolicyMasks`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-policy-mask" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } } ], "result": { "name": "access_listPolicyMasksResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "allOf": [ { "$ref": "#/components/schemas/Result_89b7be4a" }, {} ], "description": "A project-scoped policy mask controlling which managed policies and permission sets\n are available within a project." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of project-scoped policy masks.", "x-fastmcp-top-level-schema": "PolicyMaskList" } }, "x-mcp-annotations": { "title": "List Policy Masks", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listPrincipalPolicies", "summary": "List Principal Policies", "description": "Allows an admin to list principal policies in a project with pagination. Access to this\n operation is controlled by the project. Includes disabled policies so admins can re-enable them.\n\nThe auth token's access policy must allow `action:use/listPrincipalPolicies`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-principal-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } } ], "result": { "name": "access_listPrincipalPoliciesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "userPrincipal": { "$ref": "#/components/schemas/Grantee_b325aced" }, "permissions": { "$ref": "#/components/schemas/Permissions_be44d883" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "disabledPolicy": { "enum": [ true ], "example": true }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "userPrincipal", "permissions", "tags", "rev" ], "title": "UserPrincipalPolicyData", "description": "A policy specific to a principal within a governance domain." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of principal policies.", "x-fastmcp-top-level-schema": "PrincipalPolicyList" } }, "x-mcp-annotations": { "title": "List Principal Policies", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listResourceTypes", "summary": "List Resource Types", "description": "Allows a user to page through the resource types defined for a given `serviceId`. This allows users to discover what\n resource types are available to be used when defining access policies. Access to this is operation is controlled by\n the project specified by `projectId`. When the service mask that\n applies to the project does not allow any access to the service an exception is thrown.\n\nThe auth token's access policy must allow `action:use/listResourceTypes`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-misc" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "serviceId", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "required": true, "schema": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } }, { "name": "projectErn", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "required": false, "schema": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } } ], "result": { "name": "access_listResourceTypesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "resourceType": { "type": "string", "pattern": "^resourcetype:[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Identifies a resource type within a service, formatted as \"resourcetype:\".", "example": "resourcetype:AccessPolicy" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "ern": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/Attributes" }, {} ], "description": "Identify the attributes which are included on this resource\n type." }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "tags", "rev", "ern", "resourceType" ], "description": "A resource type definition registered within a project." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of resource types.", "x-fastmcp-top-level-schema": "ResourceTypeList" } }, "x-mcp-annotations": { "title": "List Resource Types", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listRoleAssignments", "summary": "List Role Assignments", "description": "Get a page of all the RoleAssignments for the given assignment scope.\n\nThe auth token's access policy must allow `action:use/listRoleAssignments`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-role-assignment" } ], "paramStructure": "by-name", "params": [ { "name": "assignmentScopeId", "description": "Id of the object this assignment scope refers to", "required": true, "schema": { "type": "string", "description": "Id of the object this assignment scope refers to", "example": "07218c48-343d-43e2-9831-a2080445cd22" } }, { "name": "assignmentScopeType", "description": "Type of object that defines the scope of a role assignment (e.g. PROJECT, ORGANIZATION).", "required": true, "schema": { "type": "string", "description": "Type of object that defines the scope of a role assignment (e.g. PROJECT, ORGANIZATION).", "examples": [ "PDS_ORG", "ORGANIZATION", "PROJECT", "BILLING_ACCOUNT", "SUBSCRIPTION_KEY", "PORT" ], "example": "PROJECT" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } } ], "result": { "name": "access_listRoleAssignmentsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "roleAssignmentId": { "type": "string", "pattern": "^roleassignment:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Immutable UUID of this RoleAssignment", "example": "roleassignment:550e8400-e29b-41d4-a716-446655440000" }, "projectId": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Id of the project that owns this assignment", "example": "project:abc-123" }, "principal": { "$ref": "#/components/schemas/Principal" }, "roleId": { "type": "string", "pattern": "^role:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Id of the Role assigned to the principal", "example": "role:550e8400-e29b-41d4-a716-446655440000" }, "roleName": { "type": "string", "description": "Name of the Role assigned to the principal", "example": "Network Admin" }, "assignmentScope": { "$ref": "#/components/schemas/AssignmentScope" } }, "additionalProperties": false, "type": "object", "required": [ "roleAssignmentId", "projectId", "principal", "roleId", "roleName", "assignmentScope" ], "description": "An assignment of a Role to a principal." }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of role assignments.", "x-fastmcp-top-level-schema": "RoleAssignmentList" } }, "x-mcp-annotations": { "title": "List Role Assignments", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listRoles", "summary": "List Roles", "description": "Get a page of all the Roles visible. All System and Product roles are visibile,\n but visibility of Custom Roles depend on the claims in the token. For an\n Access Policy token, all Custom Roles usable by the project are visible (if\n given, otherwise the project that owns the Access Policy). For a Role\n Assignment token, all Custom Roles usable by the token's Organization are\n visible and the project args are unsupported.\n\nThe auth token's access policy must allow `action:use/listRoles`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-role" } ], "paramStructure": "by-name", "params": [ { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } }, { "name": "projectId", "description": "Globally unique identifier of a project.", "required": false, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "projectErn", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "required": false, "schema": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } } ], "result": { "name": "access_listRolesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_listRolesResult" } }, "x-mcp-annotations": { "title": "List Roles", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_listRolesByProjectId", "summary": "list roles useable by project", "description": "Get a page of all the Roles visible. All System and Product roles are visibile,\n but visibility of Custom Roles depend on the claims in the token. For an\n Access Policy token, all Custom Roles usable by the project are visible (if\n given, otherwise the project that owns the Access Policy). For a Role\n Assignment token, all Custom Roles usable by the token's Organization are\n visible and the project args are unsupported.\n\nThe auth token's access policy must allow `action:use/listRoles`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-role" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } }, { "name": "projectErn", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "required": false, "schema": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } } ], "result": { "name": "access_listRolesByProjectIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_listRolesResult" } }, "x-mcp-annotations": { "title": "list roles useable by project", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_pageResourceTypeActions", "summary": "Page Resource Type Actions", "description": "Allows a user to page through the actions which can be invoked for a given `serviceId` and `resourceType`. This\n allows users to discover what actions apply to what resource types when defining access policies.\n Access to this is operation is controlled by the project specified by `projectId`. When the service mask that\n applies to the project does not allow any access to the service an exception is thrown.\n\nThe auth token's access policy must allow `action:use/listResourceTypeActions`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-misc" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "serviceId", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "required": true, "schema": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" } }, { "name": "resourceType", "description": "Identifies a resource type within a service, formatted as \"resourcetype:\".", "required": true, "schema": { "type": "string", "pattern": "^resourcetype:[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Identifies a resource type within a service, formatted as \"resourcetype:\".", "example": "resourcetype:AccessPolicy" } }, { "name": "resourceTypeServiceId", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "required": false, "schema": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" } }, { "name": "lastAction", "description": "Id of an action, unique across all aspects of its service", "required": false, "schema": { "type": "string", "pattern": "^action:(use|srv|ops)/([a-zA-Z][a-zA-Z0-9-]{0,100})$", "description": "Id of an action, unique across all aspects of its service", "example": "action:use/listPermissionSets" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } }, { "name": "projectErn", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "required": false, "schema": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } } ], "result": { "name": "access_pageResourceTypeActionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "resourceType": { "type": "string", "pattern": "^resourcetype:[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Identifies a resource type within a service, formatted as \"resourcetype:\".", "example": "resourcetype:AccessPolicy" }, "resourceTypeErn": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "action": { "type": "string", "pattern": "^action:(use|srv|ops)/([a-zA-Z][a-zA-Z0-9-]{0,100})$", "description": "Id of an action, unique across all aspects of its service", "example": "action:use/listPermissionSets" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" } }, "additionalProperties": false, "type": "object", "required": [ "resourceTypeErn", "action", "rev" ], "description": "A named action defined on a resource type within a service." }, "type": "array", "description": "A list of resource type actions." }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of resource type actions.", "x-fastmcp-top-level-schema": "ResourceTypeActionPage" } }, "x-mcp-annotations": { "title": "Page Resource Type Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_removeGrant", "summary": "Remove Grant", "description": "Allows a user to remove an external grant from an access policy including a managed policy. Access to this operation\n is controlled by the access policy being accessed.\n\nThe auth token's access policy must allow `action:use/removeGrant`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "grantId", "description": "Uniquely identifies an access policy grant.", "required": true, "schema": { "type": "string", "pattern": "^grant:[A-Z0-9]{13}$", "description": "Uniquely identifies an access policy grant.", "example": "grant:ABCDEFGHIJ123" } }, { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_0e5d0ba1" } } ], "result": { "name": "access_removeGrantResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Remove Grant", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "access_updateAccessPolicy", "summary": "Update Access Policy", "description": "Allows a user to update the definition of an access policy identified by the `accessPolicyId`.\n The access policy is updated in the project identified by the `projectId`. It is possible that\n some of the objects referenced by the updated access policy no longer exist or are no longer accessible. Such cases\n will produce an error unless the `allowBadRefs` parameter is set to \"existing\". Setting this parameter allows users\n to update access policies even if something unrelated to their update has changed since the access policy was\n created. Using this flag allows urgent access policy changes to be made without requiring the caller to address\n issues outside of their immediate concrent. Access to this operation is controlled by the access policy being\n accessed.\n\nThe auth token's access policy must allow `action:use/updateAccessPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-access-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_23abb2eb" } }, { "name": "accessPolicyId", "description": "Uniquely identifies an access policy within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/AccessPolicyId_80cae0a0" } }, { "name": "tags", "description": "Additional user-controlled data about this resource.", "required": true, "schema": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." } }, { "name": "permissions", "description": "A set of permissions, each of which may be an inline permission, a permission set reference,\n or a foreign access policy reference.", "required": true, "schema": { "$ref": "#/components/schemas/Permissions_0c73f7d1" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } }, { "name": "description", "required": false, "schema": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." } }, { "name": "intersect", "description": "Entries must appear in both the `intersect` field and the `permissions` to be in the\n results from this permission object.", "required": false, "schema": { "$ref": "#/components/schemas/Intersect" } }, { "name": "subtract", "description": "Entries in the `subtract` field are not included in the results from this permission\n object.", "required": false, "schema": { "$ref": "#/components/schemas/Subtract_46ea2c39" } }, { "name": "allowBadRefs", "description": "Indicates that the access policy should be updated even if it includes\n invalid references to permission objects. Setting to \"existing\" will allow existing\n invalid references to remain, but will complain if new invalid references are\n introduced. Setting to \"additional\" will allow both existing and new invalid\n references to be accepted without complaint.", "required": false, "schema": { "type": "string", "enum": [ "existing", "additional" ], "description": "Indicates that the access policy should be updated even if it includes\n invalid references to permission objects. Setting to \"existing\" will allow existing\n invalid references to remain, but will complain if new invalid references are\n introduced. Setting to \"additional\" will allow both existing and new invalid\n references to be accepted without complaint.", "example": "additional" } } ], "result": { "name": "access_updateAccessPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserAccessPolicyData" } }, "x-mcp-annotations": { "title": "Update Access Policy", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_updatePermissionSet", "summary": "Update Permission Set", "description": "Allows a user to update the definition of a permission set identified by the `permissionSetId`.\n The permission set is updated in the project identified by `projectId`. It is possible that\n some of the objects referenced by the updated permission set no longer exist or are no longer accessible. Such cases\n will produce an error unless the `allowBadRefs` parameter is set to \"existing\". Setting this parameter allows users\n to update permission sets even if something unrelated to their update has changed since the permission set was\n created. Using this flag allows urgent permission set changes to be made without requiring the caller to address\n issues outside of their immediate concrent. Access to this operation is controlled by the permission set being\n accessed.\n\nThe auth token's access policy must allow `action:use/updatePermissionSet`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-permission-set" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that permissionSetId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_db7dc4f4" } }, { "name": "permissionSetId", "description": "Uniquely identifies a PermissionSet within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/PermissionSetId_aebbfdbe" } }, { "name": "tags", "description": "Additional user-controlled data about this resource.", "required": true, "schema": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." } }, { "name": "permissions", "description": "A set of permissions, each of which may be an inline permission, a permission set reference,\n or a foreign access policy reference.", "required": true, "schema": { "$ref": "#/components/schemas/Permissions_0c73f7d1" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } }, { "name": "description", "required": false, "schema": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." } }, { "name": "intersect", "description": "Entries must appear in both the `intersect` field and the `permissions` to be in the\n results from this permission object.", "required": false, "schema": { "$ref": "#/components/schemas/Intersect" } }, { "name": "subtract", "description": "Entries in the `subtract` field are not included in the results from this permission\n object.", "required": false, "schema": { "$ref": "#/components/schemas/Subtract_46ea2c39" } }, { "name": "allowBadRefs", "description": "Indicates that the permission set should be updated even if it includes\n invalid references to permission objects. Setting to \"existing\" will allow existing invalid references to remain, but\n will complain if new invalid references are introduced. Setting to \"additional\" will allow both existing and new\n invalid references to be accepted without complaint.", "required": false, "schema": { "type": "string", "enum": [ "existing", "additional" ], "description": "Indicates that the permission set should be updated even if it includes\n invalid references to permission objects. Setting to \"existing\" will allow existing invalid references to remain, but\n will complain if new invalid references are introduced. Setting to \"additional\" will allow both existing and new\n invalid references to be accepted without complaint.", "example": "additional" } } ], "result": { "name": "access_updatePermissionSetResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PermissionSet_7ed0c398" } }, "x-mcp-annotations": { "title": "Update Permission Set", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_updatePolicyMask", "summary": "Update Policy Mask", "description": "Allows a user to update a project-scoped policy mask. Access is controlled by the mask.\n\nThe auth token's access policy must allow `action:use/updatePolicyMask`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-policy-mask" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that policyMaskId is an ERN.", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId_6fa8ff36" } }, { "name": "policyMaskId", "description": "Uniquely identifies a policy mask globally or within a governing project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "required": true, "schema": { "$ref": "#/components/schemas/PolicyMaskId" } }, { "name": "tags", "description": "Additional user-controlled data about this resource.", "required": true, "schema": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } }, { "name": "managedPolicies", "required": false, "schema": { "$ref": "#/components/schemas/ManagedPolicies" } }, { "name": "managedPermissionSets", "required": false, "schema": { "$ref": "#/components/schemas/ManagedPermissionSets" } }, { "name": "subtract", "required": false, "schema": { "$ref": "#/components/schemas/Subtract_d5f41db4" } }, { "name": "description", "required": false, "schema": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." } } ], "result": { "name": "access_updatePolicyMaskResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Access_createPolicyMaskResult" } }, "x-mcp-annotations": { "title": "Update Policy Mask", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "access_updatePrincipalPolicy", "summary": "Update Principal Policy", "description": "Updates a principal policy in a project by user principal. Access to this operation\n is controlled at the project level. Fails if the policy is disabled.\n\nThe auth token's access policy must allow `action:use/updatePrincipalPolicy`.\n\nPart of the Equinix Access Service API family (access). Manage access policies and role assignments.", "tags": [ { "name": "access" }, { "name": "identity" }, { "name": "permissions" }, { "name": "v1-principal-policy" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "userPrincipal", "description": "Globally unique string identifier for a principal formatted like \"principal:...\".", "required": true, "schema": { "$ref": "#/components/schemas/Grantee_b325aced" } }, { "name": "permissions", "required": true, "schema": { "$ref": "#/components/schemas/Permissions_be44d883" } }, { "name": "tags", "description": "Additional user-controlled data about this resource.", "required": true, "schema": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } }, { "name": "description", "required": false, "schema": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." } }, { "name": "allowBadRefs", "description": "Indicates that the principal policy should be\n updated even if it includes invalid references to permission\n objects. Setting to \"existing\" will allow existing invalid\n references to remain, but will complain if new invalid\n references are introduced. Setting to \"additional\" will\n allow both existing and new invalid references to be\n accepted without complaint.", "required": false, "schema": { "type": "string", "enum": [ "existing", "additional" ], "description": "Indicates that the principal policy should be\n updated even if it includes invalid references to permission\n objects. Setting to \"existing\" will allow existing invalid\n references to remain, but will complain if new invalid\n references are introduced. Setting to \"additional\" will\n allow both existing and new invalid references to be\n accepted without complaint.", "example": "additional" } } ], "result": { "name": "access_updatePrincipalPolicyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/UserPrincipalPolicyData" } }, "x-mcp-annotations": { "title": "Update Principal Policy", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "accesstoken_GetOAuth2AccessToken", "summary": "Generate New Access Token", "description": "This API handles authentication and authorization of the API developer. It returns an access_token which would be valid for 60 minutes. The user account will get locked after 5 successive invalid attempts.\n\nPart of the Equinix API Authentication API family (accesstoken). Obtain OAuth2 API access tokens (legacy Equinix API authentication).", "tags": [ { "name": "accesstoken" }, { "name": "OAuth2 Token" }, { "name": "auth" }, { "name": "identity" } ], "paramStructure": "by-name", "params": [ { "name": "client_id", "description": "API Consumer Key available under \"My Apps\" in developer portal", "required": true, "schema": { "type": "string", "description": "API Consumer Key available under \"My Apps\" in developer portal" } }, { "name": "client_secret", "description": "API Consumer secret available under \"My Apps\" in developer portal", "required": true, "schema": { "type": "string", "description": "API Consumer secret available under \"My Apps\" in developer portal" } }, { "name": "user_name", "description": "Deprecated - The Equinix username used to access portals", "required": false, "schema": { "type": "string", "description": "Deprecated - The Equinix username used to access portals" } }, { "name": "user_password", "description": "Deprecated - The Equinix user password used to access portals", "required": false, "schema": { "type": "string", "description": "Deprecated - The Equinix user password used to access portals" } }, { "name": "grant_type", "description": "The OAuth2 grant type used for authorization. Supported values are \"password\" & \"client_credentials\". user_name and password is not considered in case this value is \"client_credentials\". If the grant_type is not passed, by default it would consider \"password\" type in which user_name and password is required. Note that the password grant type is deprecated. Recommended to use grant_type of 'client_credentials' instead.", "required": false, "schema": { "type": "string", "description": "The OAuth2 grant type used for authorization. Supported values are \"password\" & \"client_credentials\". user_name and password is not considered in case this value is \"client_credentials\". If the grant_type is not passed, by default it would consider \"password\" type in which user_name and password is required. Note that the password grant type is deprecated. Recommended to use grant_type of 'client_credentials' instead." } }, { "name": "password_encoding", "description": "For enhanced security, you may encrypt the password value while requesting for an access_token. Currently only \"md5-b64\" hashing is supported. Any other value would treat password value as raw string", "required": false, "schema": { "type": "string", "description": "For enhanced security, you may encrypt the password value while requesting for an access_token. Currently only \"md5-b64\" hashing is supported. Any other value would treat password value as raw string", "default": "none" } } ], "result": { "name": "accesstoken_GetOAuth2AccessTokenResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Accesstoken_GetOAuth2AccessTokenResult" } }, "x-mcp-annotations": { "title": "Generate New Access Token", "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "accesstoken_RefreshOAuth2AccessToken", "summary": "Renew Access Tokens", "description": "Use this API to refresh an access token using its refresh token. A valid refresh token is needed to retrieve a new access_token.\n\nPart of the Equinix API Authentication API family (accesstoken). Obtain OAuth2 API access tokens (legacy Equinix API authentication).", "tags": [ { "name": "accesstoken" }, { "name": "OAuth2 Token" }, { "name": "auth" }, { "name": "identity" } ], "paramStructure": "by-name", "params": [ { "name": "client_id", "description": "API Consumer Key available under \"My Apps\" in developer portal", "required": true, "schema": { "type": "string", "description": "API Consumer Key available under \"My Apps\" in developer portal" } }, { "name": "client_secret", "description": "API Consumer secret available under \"My Apps\" in developer portal", "required": true, "schema": { "type": "string", "description": "API Consumer secret available under \"My Apps\" in developer portal" } }, { "name": "refresh_token", "description": "The OAuth2 refresh_token retrieved from the previous successful Access Token API call", "required": true, "schema": { "type": "string", "description": "The OAuth2 refresh_token retrieved from the previous successful Access Token API call" } } ], "result": { "name": "accesstoken_RefreshOAuth2AccessTokenResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Accesstoken_GetOAuth2AccessTokenResult" } }, "x-mcp-annotations": { "title": "Renew Access Tokens", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "arazzo_describe_workflow", "summary": "Describe Workflow", "description": "Describe a specific Arazzo workflow (summary, inputs).", "tags": [ { "name": "workflows" } ], "paramStructure": "by-name", "params": [ { "name": "workflow_id", "required": true, "schema": { "type": "string" } } ], "result": { "name": "arazzo_describe_workflowResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "additionalProperties": true, "type": "object" } } }, { "name": "arazzo_list_workflows", "summary": "List Workflows", "description": "List registered Arazzo workflow IDs.", "tags": [ { "name": "workflows" } ], "paramStructure": "by-name", "params": [], "result": { "name": "arazzo_list_workflowsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "result": { "items": { "type": "string" }, "type": "array" } }, "required": [ "result" ], "type": "object", "x-fastmcp-wrap-result": true } } }, { "name": "assets_getAssetById", "summary": "Get details of an asset", "description": "The Get assets by Id API returns all details for a specific asset from its identification number. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.\n\nPart of the Equinix Install Bases Asset API family (assets). Assets are all the products and equipment belonging to your organization that are installed in Equinix's IBXs. These assets can be viewed by users with the appropriate permissions. Assets can be searched by a filter criterion, or the details of an individual asset can be looked up by its asset ID.", "tags": [ { "name": "assets" }, { "name": "Assets" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "assetId", "description": "{assetId} identification number", "required": true, "schema": { "type": "string", "description": "{assetId} identification number" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "assets_getAssetByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Asset", "type": "object", "properties": { "assetNumber": { "type": "string", "description": "Asset number." }, "serialNumber": { "type": "string", "description": "Serial number of the asset." }, "orderNumber": { "type": "string", "description": "Order number associated with the asset/service." }, "productName": { "type": "string", "description": "Product type." }, "ibx": { "type": "string", "description": "Ibx of the location." }, "cage": { "type": "string", "description": "Cage of the location." }, "productDescription": { "type": "string", "description": "Product description." }, "accountNumber": { "type": "string", "description": "Account number of the product/services belongs to." }, "accountName": { "type": "string", "description": "Account name of the product/services." }, "installationDate": { "type": "string", "description": "Date time of the product or service is purchased/installed.", "format": "date-time" }, "customerReferenceNumber": { "type": "string", "description": "Customer reference number." }, "status": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" }, "productDetails": { "type": "array", "items": { "title": "AssetsProperty", "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string", "description": "Key of the property." }, "value": { "type": "string", "description": "Value of the property." }, "tag": { "type": "string", "description": "Stands for a logical grouping on where the asset belogs to for a particular product. e.g - A-SIDE for Cross Connect." } }, "description": "key/value pair representing assets property." }, "description": "key/value pairs of product details." } }, "description": "assets details.", "x-fastmcp-top-level-schema": "asset" } }, "x-mcp-annotations": { "title": "Get details of an asset", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "assets_searchAssets", "summary": "Search permissible assets", "description": "The POST assets API returns all assets for a specific asset from search form. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.\n\nPart of the Equinix Install Bases Asset API family (assets). Assets are all the products and equipment belonging to your organization that are installed in Equinix's IBXs. These assets can be viewed by users with the appropriate permissions. Assets can be searched by a filter criterion, or the details of an individual asset can be looked up by its asset ID.", "tags": [ { "name": "assets" }, { "name": "Assets" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } }, { "name": "sorts", "description": "Sort fields ", "required": false, "schema": { "type": "array", "items": { "enum": [ "SERIAL_NUMBER", "ORDER_NUMBER", "PRODUCT_TYPE", "PRODUCT_NAME", "CAGE", "IBX", "PRODUCT_DESCRIPTION", "ACCOUNT_NUMBER", "INSTALLED_DATE", "ASSET_NUMBER", "-SERIAL_NUMBER", "-ORDER_NUMBER", "-PRODUCT_TYPE", "-PRODUCT_NAME", "-CAGE", "-IBX", "-PRODUCT_DESCRIPTION", "-ACCOUNT_NUMBER", "-INSTALLED_DATE", "-ASSET_NUMBER" ], "type": "string" }, "description": "Sort fields " } }, { "name": "source", "description": "\"q\" parameter will be searched in these fields, by default search will performed on all fields", "required": false, "schema": { "type": "array", "items": { "enum": [ "LEGACY_CAGE", "LEGACY_CABINET", "LEGACY_PATCH_PANEL", "LEGACY_SALES_ORDER", "BILLING_AGREEMENT", "CAGE", "CABINET", "PATCH_PANEL", "ASSET_NUMBER", "CUSTOMER_INTERNAL_REFERENCE", "SALES_ORDER_NUMBER", "CABLE_ID", "CARRIER_CIRCUIT_ID", "SERIAL_NUMBER", "EXTERNAL_REFERENCE_NUMBER", "ACCOUNT_NUMBER" ], "type": "string" }, "description": "\"q\" parameter will be searched in these fields, by default search will performed on all fields" } }, { "name": "q", "description": "To support add a keyword, free text search on source fields. Min 3 character for efficient search results.", "required": false, "schema": { "type": "string", "description": "To support add a keyword, free text search on source fields. Min 3 character for efficient search results." } }, { "name": "exactMatch", "description": "flag determines the q should be Exact match or partial match, By default flag is false", "required": false, "schema": { "type": "boolean", "description": "flag determines the q should be Exact match or partial match, By default flag is false" } }, { "name": "offset", "description": "The start index from which the list is created.", "required": false, "schema": { "description": "The start index from which the list is created." } }, { "name": "limit", "description": "Number of entries in response.", "required": false, "schema": { "description": "Number of entries in response." } }, { "name": "filter", "description": "assets search filter.", "required": false, "schema": { "type": "object", "properties": { "ibxs": { "type": "array", "items": { "type": "string", "example": "AM5" }, "description": "List of IBX to be filtered." }, "cages": { "type": "array", "items": { "type": "string", "example": "AM5:01:000Z3C" }, "description": "List of cages to be filtered." }, "productTypes": { "type": "array", "items": { "enum": [ "ACCESSORIES", "CABINET", "CAGE", "CROSS_CONNECT", "CROSS_CONNECT_Z_SIDE", "EQUINIX_ETHERNET_EXCHANGE", "EQUINIX_CLOUD_EXCHANGE", "PATCH_PANEL", "POWER", "IBX_SMARTVIEW", "OTHERS", "VIRTUAL_CIRCUIT", "BCTR_BCS_ROOM", "EQUINIX_CONNECT" ], "type": "string" }, "description": "List of product types to be filtered." }, "dateRange": { "required": [ "fromDate", "toDate" ], "type": "object", "properties": { "fromDate": { "type": "string", "description": "Start date to filter the installed date.", "format": "date-time" }, "toDate": { "type": "string", "description": "End date to filter the installed date.", "format": "date-time" } }, "description": "Date range filter. The installed date should be within this data range." } }, "description": "assets search filter." } } ], "result": { "name": "assets_searchAssetsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "AssetsSearchResponse", "type": "object", "allOf": [ { "properties": { "data": { "type": "array", "items": { "title": "AssetsSummary", "type": "object", "properties": { "assetNumber": { "type": "string", "description": "Asset number." }, "serialNumber": { "type": "string", "description": "Serial number of the asset." }, "orderNumber": { "type": "string", "description": "Order number associated with the asset/service." }, "productName": { "type": "string", "description": "Product type." }, "ibx": { "type": "string", "description": "Ibx of the location." }, "cage": { "type": "string", "description": "Cage of the location." }, "productDescription": { "type": "string", "description": "Product description." }, "accountNumber": { "type": "string", "description": "Account number of the product/services belongs to." }, "accountName": { "type": "string", "description": "Account name of the product/services." }, "installationDate": { "type": "string", "description": "Date time of the product or service is purchased/installed.", "format": "date-time" }, "customerReferenceNumber": { "type": "string", "description": "Customer reference number." }, "status": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" }, "additionalDetails": { "title": "AdditionalDetails", "type": "object", "properties": { "cabinetNumber": { "type": "string" }, "customerOrCarrierCircuitID": { "type": "string" } }, "description": "These are additional details specific to the asset" } } } }, "page": { "title": "PageInfo", "type": "object", "properties": { "limit": { "type": "integer", "description": "Starting count based on offset." }, "offset": { "type": "integer", "description": "Limit count per page." }, "total": { "type": "integer", "description": "Matching record count / total number records matched with filter." }, "sorts": { "type": "array", "items": { "enum": [ "SERIAL_NUMBER", "-SERIAL_NUMBER", "ORDER_NUMBER", "-ORDER_NUMBER", "PRODUCT_TYPE", "-PRODUCT_TYPE", "CAGE", "-CAGE", "IBX", "-IBX", "PRODUCT_DESCRIPTION", "-PRODUCT_DESCRIPTION", "ACCOUNT_NUMBER", "-ACCOUNT_NUMBER", "INSTALLED_DATE", "-INSTALLED_DATE" ], "type": "string" } } } }, "_links": { "title": "_links", "type": "object", "properties": { "next": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, "self": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, "previous": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } } } } } } ], "x-fastmcp-top-level-schema": "assets-search-response" } }, "x-mcp-annotations": { "title": "Search permissible assets", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "attachments_createAttachment", "summary": "Upload a Multipart File", "description": "This method can be used to upload an attachment as a multipart file.\n\nPart of the Equinix Attachments as a Service API family (attachments). Attachment Management API for Equinix Customer Portal.", "tags": [ { "name": "attachments" }, { "name": "Attachments" }, { "name": "files" }, { "name": "portal" } ], "paramStructure": "by-name", "params": [ { "name": "purpose", "description": "Purpose of the file is uploaded. [ ex. LOA is for Cross connect, PO is for Purchar order ]", "required": false, "schema": { "enum": [ "LOA", "PO_DOCUMENT" ], "type": "string", "description": "Purpose of the file is uploaded. [ ex. LOA is for Cross connect, PO is for Purchar order ]" } }, { "name": "uploadFile", "description": "The file to be uploaded", "required": false, "schema": { "type": "string", "description": "The file to be uploaded", "format": "binary" } } ], "result": { "name": "attachments_createAttachmentResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Attachment_4e90c1b5" } }, "x-mcp-annotations": { "title": "Upload a Multipart File", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "attachments_deleteAttachment", "summary": "Delete Attachment by Id", "description": "This method deletes the attachment with a specific id value.\n\nPart of the Equinix Attachments as a Service API family (attachments). Attachment Management API for Equinix Customer Portal.", "tags": [ { "name": "attachments" }, { "name": "Attachments" }, { "name": "files" }, { "name": "portal" } ], "paramStructure": "by-name", "params": [ { "name": "attachmentId", "description": "The id of the attachment.", "required": true, "schema": { "description": "The id of the attachment." } } ], "result": { "name": "attachments_deleteAttachmentResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Status", "required": [ "status" ], "type": "object", "properties": { "status": { "type": "boolean", "description": "Status message", "default": false } }, "example": { "status": false }, "x-fastmcp-top-level-schema": "status" } }, "x-mcp-annotations": { "title": "Delete Attachment by Id", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "attachments_getAttachedFile", "summary": "Download Attachment File", "description": "This method gets the binary file attachment with a specific attachment id value.\n\nPart of the Equinix Attachments as a Service API family (attachments). Attachment Management API for Equinix Customer Portal.", "tags": [ { "name": "attachments" }, { "name": "Attachments" }, { "name": "files" }, { "name": "portal" } ], "paramStructure": "by-name", "params": [ { "name": "attachmentId", "description": "The id of the attachment record you want to get binary data from.", "required": true, "schema": { "description": "The id of the attachment record you want to get binary data from." } } ], "result": { "name": "attachments_getAttachedFileResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Download Attachment File", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "attachments_getAttachment", "summary": "Get Attachment by Id", "description": "This method gets the metadata for the attachment file with a specific. attachment id value.\n\nPart of the Equinix Attachments as a Service API family (attachments). Attachment Management API for Equinix Customer Portal.", "tags": [ { "name": "attachments" }, { "name": "Attachments" }, { "name": "files" }, { "name": "portal" } ], "paramStructure": "by-name", "params": [ { "name": "attachmentId", "description": "The id of the attachment.", "required": true, "schema": { "description": "The id of the attachment." } } ], "result": { "name": "attachments_getAttachmentResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Attachment_4e90c1b5" } }, "x-mcp-annotations": { "title": "Get Attachment by Id", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "attachments_getAttachments", "summary": "Get List of Attachments", "description": "This method gets the metadata for multiple attachments. The response is paginated and will output limited number of records per page.\n\nPart of the Equinix Attachments as a Service API family (attachments). Attachment Management API for Equinix Customer Portal.", "tags": [ { "name": "attachments" }, { "name": "Attachments" }, { "name": "files" }, { "name": "portal" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "Page number to skip the results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "description": "Page number to skip the results" } }, { "name": "limit", "description": "Number of expected records in the response", "required": false, "schema": { "maximum": 100.0, "minimum": 0.0, "type": "integer", "default": 20, "description": "Number of expected records in the response" } }, { "name": "attachmentIds", "description": "Comma separated attachment ids to search", "required": false, "schema": { "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Comma separated attachment ids to search" } } ], "result": { "name": "attachments_getAttachmentsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Records", "required": [ "data", "_links" ], "type": "object", "properties": { "data": { "minItems": 0, "type": "array", "items": { "title": "Attachment", "required": [ "attachmentId", "attachmentName", "attachmentType", "attachmentSize", "createdDate", "createdBy", "lastUpdatedDate" ], "type": "object", "properties": { "attachmentId": { "type": "string", "description": "Unique Identifier for the attachment", "format": "uuid" }, "attachmentName": { "type": "string", "description": "File name of the attachment" }, "attachmentType": { "type": "string", "description": "Extension of the document" }, "attachmentSize": { "maximum": 1000000000.0, "minimum": 0.0, "type": "number", "description": "size of the attachment in bytes", "default": 0 }, "createdDate": { "type": "string", "description": "Created date", "format": "date-time" }, "createdBy": { "type": "string", "description": "User key of the author of the attachment" }, "lastUpdatedDate": { "type": "string", "description": "Last accessed date for the record", "format": "date-time" } }, "description": "Attachment meta data", "example": { "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093", "attachmentName": "Example_Invoice.pdf", "attachmentType": "application/pdf", "attachmentSize": 259387, "createdDate": "2017-01-31T09:03:08.340Z", "createdBy": "john.doe@example.com", "lastUpdatedDate": "2017-04-06T17:10:44.807Z" } }, "description": "List of records" }, "page": { "title": "Page", "required": [ "total", "limit", "offset" ], "type": "object", "properties": { "total": { "minimum": 0.0, "type": "number", "description": "Total number of records", "default": 0 }, "limit": { "minimum": 0.0, "type": "integer", "description": "Number of records per page", "default": 0 }, "offset": { "minimum": 0.0, "type": "integer", "description": "The page number", "default": 0 }, "sorts": { "type": "array", "items": { "type": "string" }, "description": "Sorted by latest created attachments" } }, "example": { "total": 100, "limit": 20, "offset": 0, "sorts": [ "-createdDate" ] } }, "_links": { "title": "Links", "required": [ "first", "self" ], "type": "object", "properties": { "first": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/attachments?limit=10" } }, "next": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/attachments?limit=10" } }, "self": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/attachments?limit=10" } }, "prev": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/attachments?limit=10" } }, "last": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/attachments?limit=10" } } }, "example": { "first": { "href": "/attachments?limit=10&offset=0" }, "next": { "href": "/attachments?limit=10&offset=50" }, "self": { "href": "/attachments?limit=10&offset=40" }, "prev": { "href": "/attachments?limit=10&offset=30" }, "last": { "href": "/attachments?limit=10&offset=100" } } } }, "example": { "data": [ { "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2094", "attachmentName": "Example_Invoice_1.xlsx", "attachmentType": "xlsx", "attachmentSize": 259388, "createdDate": "2017-01-31T09:03:08.340Z", "createdBy": "john.doe@example.com", "lastUpdatedDate": "2017-04-06T17:10:44.807Z" }, { "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093", "attachmentName": "Example_Invoice_2.xlsx", "attachmentType": "xlsx", "attachmentSize": 259387, "createdDate": "2017-01-31T09:03:08.340Z", "createdBy": "john.doe@example.com", "lastUpdatedDate": "2017-04-06T17:10:44.807Z" } ], "page": { "total": 1200, "limit": 100, "offset": 0, "sorts": [ "-createdDate", "attachmentId" ] }, "_links": { "first": { "href": "/attachments?limit=10&offset=0" }, "next": { "href": "/attachments?limit=10&offset=50" }, "self": { "href": "/attachments?limit=10&offset=40" }, "prev": { "href": "/attachments?limit=10&offset=30" }, "last": { "href": "/attachments?limit=10&offset=100" } } }, "x-fastmcp-top-level-schema": "records" } }, "x-mcp-annotations": { "title": "Get List of Attachments", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "bas_getBillingAccountByAccountId", "summary": "Get Billing account detail by account id", "description": "Get billing account detail by account id\n\nPart of the Equinix Platform Billing Account API family (bas). Billing Account Service (BAS): search and retrieve customer billing accounts.", "tags": [ { "name": "bas" }, { "name": "Billing Account" }, { "name": "billing" } ], "paramStructure": "by-name", "params": [ { "name": "accountId", "description": "Billing Account Id", "required": true, "schema": { "type": "string", "example": "C-12345", "description": "Billing Account Id" } } ], "result": { "name": "bas_getBillingAccountByAccountIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Bas_getBillingAccountByAccountIdResult" } }, "x-mcp-annotations": { "title": "Get Billing account detail by account id", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "bas_getBillingAccountByAccountNumber", "summary": "Get billing account detail by account number", "description": "Get billing account detail by account number\n\nPart of the Equinix Platform Billing Account API family (bas). Billing Account Service (BAS): search and retrieve customer billing accounts.", "tags": [ { "name": "bas" }, { "name": "Billing Account" }, { "name": "billing" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Billing account number", "required": true, "schema": { "type": "string", "example": 12345, "description": "Billing account number" } } ], "result": { "name": "bas_getBillingAccountByAccountNumberResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Bas_getBillingAccountByAccountIdResult" } }, "x-mcp-annotations": { "title": "Get billing account detail by account number", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "bas_searchBillingAccount", "summary": "Get customer's billing accounts", "description": "Get customer's billing accounts\n\nPart of the Equinix Platform Billing Account API family (bas). Billing Account Service (BAS): search and retrieve customer billing accounts.", "tags": [ { "name": "bas" }, { "name": "Billing Account" }, { "name": "billing" } ], "paramStructure": "by-name", "params": [ { "name": "ibxCode", "description": "IBX where billing account can place order.", "required": false, "schema": { "type": "string", "description": "IBX where billing account can place order.", "example": "SV1" } }, { "name": "metroCode", "description": "Metro where billing account can place order.", "required": false, "schema": { "type": "string", "description": "Metro where billing account can place order.", "example": "SV" } }, { "name": "accountStatus", "description": "List of account status to search.", "required": false, "schema": { "type": "array", "items": { "enum": [ "ACTIVE", "PENDING_SIGNATURE", "CREDIT_HOLD", "IN_PROGRESS", "DECLINED" ], "type": "string", "description": "Billing account status", "example": "ACTIVE" }, "description": "List of account status to search.", "example": [ "ACTIVE" ] } }, { "name": "projectId", "description": "Project id where billing account associated with.", "required": false, "schema": { "type": "string", "description": "Project id where billing account associated with.", "example": "10d8f2af-07f5-4276-9569-2aa46425713c" } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "maximum": 100.0, "minimum": 1.0, "type": "integer", "description": "Specifies the page size.", "default": 100, "example": 100 } }, { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "minimum": 0.0, "type": "integer", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "default": 0, "example": 0 } } ], "result": { "name": "bas_searchBillingAccountResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "properties": { "pagination": { "properties": { "offset": { "type": "integer", "description": "It is the starting point of the collection returned fromt the server.", "example": 0 }, "limit": { "type": "integer", "description": "The page size.", "example": 100 }, "total": { "type": "integer", "description": "The total number of results.", "example": 1 } }, "description": "Pagination info" }, "data": { "type": "array", "items": { "properties": { "accountId": { "type": "string", "description": "Billing account ID.", "example": "C-12345" }, "accountNumber": { "type": "string", "description": "Billing account number.", "example": "12345" }, "accountName": { "type": "string", "description": "Billing account name.", "example": "Equinix" }, "currency": { "type": "string", "description": "Billing account currency.", "example": "USD" }, "billingCountry": { "type": "string", "description": "Billing account country.", "example": "US" }, "accountStatus": { "enum": [ "ACTIVE", "PENDING_SIGNATURE", "CREDIT_HOLD", "IN_PROGRESS", "DECLINED" ], "type": "string", "description": "Billing account status", "example": "ACTIVE" }, "isGlobal": { "type": "boolean", "description": "Indicator for billing account type. true = Global billing account, false = Local billing account", "example": true }, "isPoRequired": { "type": "boolean", "description": "Indicator for pucharse order required.", "example": false }, "isSignatureRequired": { "type": "boolean", "description": "Indicator for signature required.", "example": false }, "isReseller": { "type": "boolean", "description": "Indicator for reseller.", "example": false }, "isSubCustomer": { "type": "boolean", "description": "Indicator for sub customer.", "example": false }, "createdDatetime": { "type": "string", "description": "Billing Account created datetime", "format": "date-time", "example": "2020-05-21T10:30:00+00:00" }, "lastModifiedDatetime": { "type": "string", "description": "Billing account last modified datetime", "format": "date-time", "example": "2020-05-23T12:30:00+00:00" } } }, "description": "Search result" } }, "x-fastmcp-top-level-schema": "SearchResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get customer's billing accounts", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "billing_Retrieve_billing_details", "summary": "Retrieve billing details", "description": "This method retrieves detailed invoice or credit memo information based on date range, account number or transactions ID for a user with billing viewing permission.\n\nPart of the Equinix Billing API family (billing). The Billing API allows users to view summarized and detailed versions of invoices and credit memos. Users can filter the responses based on date range, account numbers, and transaction IDs.", "tags": [ { "name": "billing" }, { "name": "Billing Invoices" } ], "paramStructure": "by-name", "params": [ { "name": "startDate", "description": "Start date of invoice in `YYYY-MM-DD` format", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-09-17", "description": "Start date of invoice in `YYYY-MM-DD` format" } }, { "name": "endDate", "description": "End date of invoice in `YYYY-MM-DD` format", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-17", "description": "End date of invoice in `YYYY-MM-DD` format" } }, { "name": "accountNumbers", "description": "List of accounts to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of accounts to be filtered" } }, { "name": "transactionIds", "description": "List of transactions to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of transactions to be filtered" } }, { "name": "offset", "description": "Use offset to control the number of records to be skipped in the response.", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "description": "Use offset to control the number of records to be skipped in the response." } }, { "name": "limit", "description": "Use limit to restrict the number of records in the response.", "required": false, "schema": { "maximum": 200.0, "minimum": 1.0, "type": "integer", "default": 10, "description": "Use limit to restrict the number of records in the response." } } ], "result": { "name": "billing_Retrieve_billing_detailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Unique identifier for a specific transaction. A transaction type can be an `INVOICE` or `CREDIT_MEMO`. ", "example": "100210235267" }, "businessLegalEntity": { "type": "string", "description": "Name of the Equinix entity that issued billing document", "example": "0100-EQUINIX INC" }, "region": { "enum": [ "APAC", "AMER", "EMEA" ], "type": "string", "description": "Region of the Equinix legal entity", "example": "EMEA" }, "countryCode": { "type": "string", "description": "Country code of the Equinix legal entity. This is not to be confused with the customer legal entity’s countryCode", "example": "ES" }, "transactionType": { "enum": [ "CREDIT_MEMO", "INVOICE" ], "type": "string", "description": "Type of transaction. Can be of `CREDIT_MEMO` or `INVOICE` ", "example": "INVOICE" }, "transactionDate": { "type": "string", "description": "Date of transaction in `YYYY-MM-DD` format", "format": "date", "example": "2020-11-19" }, "orderId": { "type": "string", "description": "Unique identifier of the order", "example": "1-180737113821" }, "channel": { "enum": [ "API", "PORTAL", "MOBILE", "OFFLINE", "OTHER" ], "type": "string", "description": "Type of channel used to place the order", "example": "PORTAL" }, "subChannel": { "enum": [ "QUOTE", "IX", "ECX", "ECP", "CSC", "NRC_CHARGE_UPLOAD" ], "type": "string", "description": "Type of sub-channel used to place the order", "example": "ECP" }, "lineNumber": { "type": "string", "description": "Line number for line item.", "example": 131210068800 }, "subLineNumber": { "type": "string", "description": "Sub-line number for line item.", "example": 2 }, "customerDetails": { "allOf": [ { "properties": { "legalEntity": { "type": "string", "description": "Name of customer legal entity", "example": "Company Corporation Ltd" }, "countryCode": { "$ref": "#/components/schemas/CountryCode_3a211f7f" } } }, { "$ref": "#/components/schemas/CustomerDetails" } ] }, "purchaseOrderNumber": { "type": "string", "description": "Purchase order number", "example": "SAU-87110-CC" }, "billingAgreementId": { "type": "string", "description": "Billing Agreement Number.", "example": "1-123456789101" }, "customerReferenceId": { "type": "string", "description": "Customer Reference Identifier / External Reference Identifier", "example": "048837d6-4cd8-401f-ba41-a4ac015c3f3e" }, "priorAdjustmentReference": { "type": "string", "description": "Prior Adjustment Invoice Id or Credit Memo Id" }, "ibxs": { "type": "array", "items": { "type": "string" }, "description": "Equinix datacenter location code", "example": "AM1" }, "recurringStartDate": { "type": "string", "description": "This refers to the start date of `totalRecurringAmount` in `YYYY-MM-DD` format", "format": "date", "example": "2020-12-01T00:00:00.000Z" }, "recurringEndDate": { "type": "string", "description": "This refers to the end date of `totalRecurringAmount` in `YYYY-MM-DD` format", "format": "date", "example": "2020-12-31T00:00:00.000Z" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of contact", "example": "John" }, "lastName": { "type": "string", "description": "Last name of contact", "example": "Doe" }, "type": { "enum": [ "BOOKED_BY", "BILLING_ANALYST" ], "type": "string" } } } }, "orderBookedDate": { "type": "string", "format": "date" }, "activityType": { "enum": [ "CREDIT_MRC", "CREDIT_NRC", "ONE_TIME_CHARGE", "RECURRING_CHARGE", "PRIOR_RECURRING_CHARGE", "ADJUSTMENT_CHARGE", "DEINSTALL" ], "type": "string" }, "productCategory": { "type": "string", "description": "Name of product category.", "example": "Interconnection" }, "productDescription": { "type": "string", "description": "Description of the product.", "example": "Cross Connect - Single-Mode Fiber" }, "productCode": { "type": "string", "description": "Product catalog code.", "example": "CC0001" }, "productName": { "type": "string", "description": "Product name.", "example": "Cross Connect" }, "detailedDescription": { "type": "string", "example": "Location: 000733 SN: 20281678-A CID: CH LZXX184890 TQW EQUINIX" }, "ibxDescription": { "type": "string", "example": "Chicago IBX - CH1" }, "quantity": { "type": "number", "description": "The total amount of quantity bought. To be used with `unitOfMeasure`", "example": 10 }, "unitOfMeasure": { "type": "string", "description": "Metric of `quantity` ", "example": "KVA" }, "unitPrice": { "type": "number", "description": "The unit price of product / service", "example": 90 }, "frequency": { "enum": [ "MONTHLY", "QUARTERLY", "YEARLY" ], "type": "string", "description": "The period of recurring charges", "example": "MONTHLY" }, "currencyCode": { "$ref": "#/components/schemas/Currency_Code" }, "localCurrencyCode": { "$ref": "#/components/schemas/Currency_Code" }, "exchangeRate": { "type": "number", "description": "The exchange rate used in computing charges when local currency is different from invoice currency. ", "example": 1.3 }, "nonRecurringAmount": { "type": "number", "description": "Amount of non-recurring charges.", "example": 50 }, "recurringAmount": { "type": "number", "description": "Amount of recurring charges.", "example": 50 }, "adjustment": { "type": "number", "description": "Amount of discounts or adjustments applied", "example": 0.1 }, "taxAmount": { "type": "number", "description": "Amount of tax applied", "example": 100 }, "totalAmount": { "type": "number", "description": "Net total amount after applicable taxes and discounts. ", "example": 100 }, "legacyOrderId": { "type": "string", "description": "Order ID that were previously used in legacy orders", "example": "1-198048780276" }, "additionalInfo": { "title": "Additional Details of the product", "type": "array", "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "example": [ { "key": "ASSET_ID", "value": "4-89137987923" }, { "key": "SERIAL_NUMBER", "value": "232891719" }, { "key": "SPACE_ID", "value": "SY2:01:000283" }, { "key": "FIRST_PRICE_INCREASE", "value": "12" }, { "key": "PRICE_INCREASE_PERCENTAGE", "value": "5" } ] }, "termsOfUse": { "type": "array", "items": { "title": "Terms of use", "type": "object", "properties": { "value": { "type": "integer", "description": "Denotes the value of period", "example": "36" }, "type": { "enum": [ "INITIAL_TERM", "RENEWAL_TERM" ], "type": "string", "description": "Type of terms of use", "example": "INITIAL_TERM" }, "period": { "enum": [ "MONTHS" ], "type": "string", "description": "Denotes the period type", "example": "MONTHS" } } } } } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "example": 0 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 100 }, "next": { "type": "string", "example": "/invoices/details?offset=25&limit=25" }, "previous": { "type": "string", "example": "/invoices/details?offset=0&limit=25" } }, "description": "Paginations" } }, "x-fastmcp-top-level-schema": "invoiceResponse" } }, "x-mcp-annotations": { "title": "Retrieve billing details", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "billing_Retrieve_billing_summary", "summary": "Retrieve billing summary", "description": "This method retrieves a summary invoice or credit memo information based on date range, account number or transactions ID for a user with billing viewing permission.\n\nPart of the Equinix Billing API family (billing). The Billing API allows users to view summarized and detailed versions of invoices and credit memos. Users can filter the responses based on date range, account numbers, and transaction IDs.", "tags": [ { "name": "billing" }, { "name": "Billing Invoices" } ], "paramStructure": "by-name", "params": [ { "name": "startDate", "description": "Start date of invoice in `YYYY-MM-DD` format", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-09-17", "description": "Start date of invoice in `YYYY-MM-DD` format" } }, { "name": "endDate", "description": "End date of invoice in `YYYY-MM-DD` format", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-10-17", "description": "End date of invoice in `YYYY-MM-DD` format" } }, { "name": "accountNumbers", "description": "List of accounts to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of accounts to be filtered" } }, { "name": "transactionIds", "description": "List of transactions to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of transactions to be filtered" } }, { "name": "offset", "description": "Use offset to control the number of records to be skipped in the response.", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "description": "Use offset to control the number of records to be skipped in the response." } }, { "name": "limit", "description": "Use limit to restrict the number of records in the response.", "required": false, "schema": { "maximum": 200.0, "minimum": 1.0, "type": "integer", "default": 10, "description": "Use limit to restrict the number of records in the response." } } ], "result": { "name": "billing_Retrieve_billing_summaryResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Unique identifier for a specific transaction. A transaction type can be an `INVOICE` or `CREDIT_MEMO`. ", "example": "100210235267" }, "businessLegalEntity": { "type": "string", "description": "Name of the Equinix entity that issued billing document", "example": "0100-EQUINIX INC" }, "customerDetails": { "allOf": [ { "$ref": "#/components/schemas/CustomerDetails" }, { "properties": { "accountContact": { "type": "string", "description": "Customer contact name.", "example": "Attn: Accounts Payable" }, "address": { "title": "Address details", "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Address line 1", "example": "ABC Street 123" }, "addressLine2": { "type": "string", "description": "Address line 2", "example": "block 11, #01-11" }, "city": { "type": "string", "description": "City name.", "example": "San Francisco" }, "state": { "type": "string", "description": "State of the city.", "example": "California" }, "countryCode": { "$ref": "#/components/schemas/CountryCode_3a211f7f" }, "zipCode": { "type": "string", "description": "Postal address", "example": "94086" } } } } } ] }, "transactionType": { "enum": [ "INVOICE", "CREDIT_MEMO" ], "type": "string", "description": "Billing Type" }, "transactionDate": { "type": "string", "description": "Billing Date", "format": "date", "example": "2020-06-01" }, "billingPurchaseOrder": { "type": "string", "description": "Purchase order reference for invoice. When there are more than 1 applicable purchase order reference, this field will display multiple instead of showing specific purchase order number. ", "example": "multiple" }, "billingCycle": { "type": "string", "description": "The start date which billing is being triggered", "example": "1st of the month" }, "billingContacts": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "details": { "type": "array", "items": { "title": "Contact Details", "type": "object", "properties": { "type": { "enum": [ "PHONE", "EMAIL", "MOBILE" ], "type": "string", "description": "Communications Type ", "example": "PHONE" }, "value": { "type": "string", "description": "Value of related `type` (eg, phone Number, email address)", "example": "+1-4601231122" } } }, "description": "Reference of the related party, could be a party reference or a party role reference" } } }, "paymentDueDate": { "type": "string", "description": "Date which payment is due for the invoice in `YYYY-MM-DD` format", "format": "date", "example": "2020-07-01" }, "paymentTerms": { "type": "string", "description": "Invoice payment terms", "example": "Net 30" }, "currencyCode": { "$ref": "#/components/schemas/Currency_Code" }, "totalRecurringAmount": { "type": "number", "description": "Total recurring charges.", "example": "19999" }, "totalNonRecurringAmount": { "type": "number", "description": "Total non-recurring charges.", "example": "22113" }, "totalAmount": { "type": "number", "description": "Total invoice charges. This includes recurring and non-recurring charges.", "example": "42112" }, "totalAdjustment": { "type": "number", "description": "Total adjustment amount. ", "example": 0.1 }, "vatNumber": { "type": "string", "description": "Customer VAT Registration number", "example": "GB123456789" }, "paymentInstructions": { "type": "object", "properties": { "electronic": { "type": "object", "properties": { "bankName": { "type": "string", "description": "Name of bank for electronic payment.", "example": "Wells Fargo Bank, NA" }, "bankAddress": { "title": "Address details", "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Address line 1", "example": "Address line 1" }, "addressLine2": { "type": "string", "description": "Address line 2", "example": "Address line 2" } } }, "payeeName": { "type": "string", "description": "Equinix payee name for electronic payment.", "example": "Equinix, INC" }, "payeeAccountNumber": { "type": "string", "description": "Equinix bank account number.", "example": "4121543037" }, "bankCode": { "type": "string", "description": "Equinix international bank account number. This can be `BSB#`, `IBAN`, `CNAP`, `ABA#` depending on the region. Please refer to appendix for more information.", "example": "121000248" }, "swiftCode": { "type": "string", "description": "Equinix SWIFT code for bank transfer", "example": "WFBIUS6S" }, "sortCode": { "type": "string", "description": "Equinix Sort code for bank transfer", "example": "" } } }, "check": { "type": "object", "properties": { "bankName": { "type": "string", "description": "Name of Bank for check payment.", "example": "Wells Fargo Bank, NA" }, "bankAddress": { "title": "Address details", "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Address line 1", "example": "Address line 1" }, "addressLine2": { "type": "string", "description": "Address line 2", "example": "Address line 2" } } } } }, "emailRemittance": { "type": "string", "description": "Email address to send remittance advice.", "example": "Remittance-AMER-NA@equinix.com" } } }, "taxInfo": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "description": "Type of tax imposed for a transaction", "example": "VAT 5% on 19103" }, "value": { "type": "number", "description": "The corresponding tax value for a given tax type.", "example": 19.01 } } } }, "priorAdjustmentInfo": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "Original invoice number which credit memo is applicable to. In some cases, this may include multiple documents consisting of credit memos and invoices.", "example": "100210214299" }, "totalAmount": { "type": "number", "description": "Original invoice value. This is only applicable to credit memo.", "example": 12630.92 }, "transactionDate": { "type": "string", "description": "Original invoice date in YYYY-MM-DD. This is only applicable to credit memo.", "example": "2020-03-01" } } } }, "totalPriorAdjustmentAmount": { "type": "number", "description": "Adjusted original total amount." } } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "example": 0 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 100 }, "next": { "type": "string", "example": "/invoices?offset=25&limit=25" }, "previous": { "type": "string", "example": "/invoices?offset=0&limit=25" } }, "description": "Pagination" } }, "x-fastmcp-top-level-schema": "invoiceSummaryResponse" } }, "x-mcp-annotations": { "title": "Retrieve billing summary", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "billingv1_downloadBillingDocument", "summary": "Download specific invoice document", "description": "This method billing document from an account by its specific invoice identifier and document identifier\n\nPart of the Equinix Billing API family (billingv1). Based on a user's permission, a User can view financial records and payment history and download invoice documents for their permitted billing accounts. The invoice and payment document can be filtered by product type, account, or date range.", "tags": [ { "name": "billingv1" }, { "name": "Accounts" }, { "name": "billing" } ], "paramStructure": "by-name", "params": [ { "name": "documentId", "description": "Document Id", "required": true, "schema": { "minLength": 1, "type": "string", "description": "Document Id" } }, { "name": "accountNumber", "description": "Account number", "required": true, "schema": { "description": "Account number" } }, { "name": "invoiceId", "description": "Invoice Id", "required": true, "schema": { "description": "Invoice Id" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "billingv1_downloadBillingDocumentResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "string", "format": "binary" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Download specific invoice document", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "billingv1_getBillingAccountByNumber", "summary": "Get specific billing account summary", "description": "This method returns a billing summary of an account based on the account number given.\n\nPart of the Equinix Billing API family (billingv1). Based on a user's permission, a User can view financial records and payment history and download invoice documents for their permitted billing accounts. The invoice and payment document can be filtered by product type, account, or date range.", "tags": [ { "name": "billingv1" }, { "name": "Accounts" }, { "name": "billing" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Account number", "required": true, "schema": { "description": "Account number" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } }, { "name": "months", "description": "Finance documents will be pulled for these months ex: 2017-12-03,2018-01-03 in ISO_LOCAL_DATE format", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "format": "date", "default": "", "description": "Finance documents will be pulled for these months ex: 2017-12-03,2018-01-03 in ISO_LOCAL_DATE format" } } ], "result": { "name": "billingv1_getBillingAccountByNumberResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Account", "type": "object", "properties": { "accountNumber": { "type": "string" }, "parentAccountNumber": { "type": "string" }, "accountName": { "type": "string" }, "billingFrequency": { "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Frequency of billing" }, "currencyCode": { "minLength": 1, "type": "string", "description": "Currency code of the account" }, "invoiceLanguage": { "type": "string", "description": "Language of the invoice" }, "invoiceFormat": { "enum": [ "PDF", "EXCEL" ], "type": "string", "description": "Format of the invoice" }, "invoices": { "$ref": "#/components/schemas/Invoices" }, "payments": { "$ref": "#/components/schemas/Payments" }, "billingContact": { "$ref": "#/components/schemas/BillingContact" }, "accountIbxs": { "type": "array", "items": { "type": "string" } } }, "example": { "accountName": "Example Inc.", "accountNumber": "124353", "parentAccountNumber": "54321", "accountIbxs": [ "IBX1", "IBX2", "IBX3", "IBX4" ], "billingContact": { "firstName": "John", "lastName": "Doe", "email": "john.doe@example.lk" }, "billingFrequency": "MONTHLY", "invoiceLanguage": "English", "invoiceFormat": "PDF", "invoices": [ { "invoiceId": "123435", "transactionNumber": "654321879", "date": "2017-03-23", "type": "CREDIT_MEMO", "amount": 13456.87, "documents": [ { "documentId": "24242", "fileType": "PDF_DETAILS", "type": "STATEMENT" }, { "documentId": "3521de", "fileType": "PDF_DETAILS", "type": "INVOICE" }, { "documentId": "234234de", "fileType": "PDF_DETAILS", "type": "MANUAL_INVOICE" } ] }, { "invoiceId": "123435", "transactionNumber": "654321879", "date": "2017-03-23", "type": "CREDIT_MEMO", "amount": -914.52, "documents": [ { "documentId": "242142", "fileType": "PDF_DETAILS", "type": "STATEMENT" } ] } ], "payments": [ { "paymentId": "123435", "amount": 43218.79, "date": "2017-03-23", "type": "APPLIED" } ], "currencyCode": "SGD" }, "x-fastmcp-top-level-schema": "account" } }, "x-mcp-annotations": { "title": "Get specific billing account summary", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "billingv1_getBillingAccounts", "summary": "Get billing accounts summary", "description": "This method returns a summary of all the billing accounts that the user has permissions to view.\n\nPart of the Equinix Billing API family (billingv1). Based on a user's permission, a User can view financial records and payment history and download invoice documents for their permitted billing accounts. The invoice and payment document can be filtered by product type, account, or date range.", "tags": [ { "name": "billingv1" }, { "name": "Accounts" }, { "name": "billing" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } }, { "name": "offset", "description": "Use offset and limit to restrict the number of users in the output. Offset can be used to specify the start record", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "description": "Use offset and limit to restrict the number of users in the output. Offset can be used to specify the start record" } }, { "name": "limit", "description": "Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response", "required": false, "schema": { "maximum": 100.0, "minimum": 0.0, "type": "integer", "default": 10, "description": "Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response" } }, { "name": "sorts", "description": "Use sorts to get the accounts in the response sorted in the particular order. for example, use '-ACCOUNT_NUMBER' to sort the reports by generated date in descending order. And 'ACCOUNT_NUMBER' for ascending order. For descending order, the field name should be prefixed with '-'", "required": false, "schema": { "enum": [ "ACCOUNT_NUMBER", "-ACCOUNT_NUMBER", "PARENT_ACCOUNT_NUMBER", "-PARENT_ACCOUNT_NUMBER", "ACCOUNT_NAME", "-ACCOUNT_NAME" ], "type": "string", "default": "ACCOUNT_NUMBER", "description": "Use sorts to get the accounts in the response sorted in the particular order. for example, use '-ACCOUNT_NUMBER' to sort the reports by generated date in descending order. And 'ACCOUNT_NUMBER' for ascending order. For descending order, the field name should be prefixed with '-'" } } ], "result": { "name": "billingv1_getBillingAccountsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Records", "required": [ "data", "_links" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "Account", "type": "object", "properties": { "accountNumber": { "type": "string" }, "parentAccountNumber": { "type": "string" }, "accountName": { "type": "string" }, "billingFrequency": { "enum": [ "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Frequency of billing" }, "currencyCode": { "minLength": 1, "type": "string", "description": "Currency code of the account" }, "invoiceLanguage": { "type": "string", "description": "Language of the invoice" }, "invoiceFormat": { "enum": [ "PDF", "EXCEL" ], "type": "string", "description": "Format of the invoice" }, "invoices": { "$ref": "#/components/schemas/Invoices" }, "payments": { "$ref": "#/components/schemas/Payments" }, "billingContact": { "$ref": "#/components/schemas/BillingContact" }, "accountIbxs": { "type": "array", "items": { "type": "string" } } }, "example": { "accountName": "Example Inc.", "accountNumber": "124353", "parentAccountNumber": "54321", "accountIbxs": [ "IBX1", "IBX2", "IBX3", "IBX4" ], "billingContact": { "firstName": "John", "lastName": "Doe", "email": "john.doe@example.lk" }, "billingFrequency": "MONTHLY", "invoiceLanguage": "English", "invoiceFormat": "PDF", "invoices": [ { "invoiceId": "123435", "transactionNumber": "654321879", "date": "2017-03-23", "type": "CREDIT_MEMO", "amount": 13456.87, "documents": [ { "documentId": "24242", "fileType": "PDF_DETAILS", "type": "STATEMENT" }, { "documentId": "3521de", "fileType": "PDF_DETAILS", "type": "INVOICE" }, { "documentId": "234234de", "fileType": "PDF_DETAILS", "type": "MANUAL_INVOICE" } ] }, { "invoiceId": "123435", "transactionNumber": "654321879", "date": "2017-03-23", "type": "CREDIT_MEMO", "amount": -914.52, "documents": [ { "documentId": "242142", "fileType": "PDF_DETAILS", "type": "STATEMENT" } ] } ], "payments": [ { "paymentId": "123435", "amount": 43218.79, "date": "2017-03-23", "type": "APPLIED" } ], "currencyCode": "SGD" } }, "description": "List accounts with billing summary" }, "page": { "title": "Page", "required": [ "total", "limit", "offset" ], "type": "object", "properties": { "total": { "minimum": 0.0, "type": "integer", "description": "Total number of records", "default": 0 }, "limit": { "minimum": 0.0, "type": "integer", "description": "Number of records per page", "default": 0 }, "offset": { "minimum": 0.0, "type": "integer", "description": "The page number", "default": 0 }, "sorts": { "type": "array", "items": { "type": "string" }, "description": "Sort fields based on polarity" } }, "example": { "total": 5469, "limit": 50, "offset": 15, "sorts": [ "cupidatat", "dolor occaecat" ] } }, "_links": { "title": "Links", "required": [ "self" ], "type": "object", "properties": { "prev": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/accounts?limit=10" } }, "self": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/accounts?limit=10" } }, "next": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/accounts?limit=10" } } }, "example": { "prev": { "href": "/accounts?limit=10&offset=50" }, "self": { "href": "/accounts?limit=10&offset=40" }, "next": { "href": "/accounts?limit=10&offset=30" } } } }, "example": { "data": [ { "accountName": "Example Inc.", "accountNumber": "124353", "parentAccountNumber": "54321", "accountIbxs": [ "IBX1", "IBX2", "IBX3", "IBX4" ] } ], "page": { "total": 1200, "limit": 20, "offset": 0 }, "_links": { "prev": { "href": "/accounts?limit=10&offset=50" }, "self": { "href": "/accounts?limit=10&offset=40" }, "next": { "href": "/accounts?limit=10&offset=30" } } }, "x-fastmcp-top-level-schema": "records" } }, "x-mcp-annotations": { "title": "Get billing accounts summary", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "call_api_filtered", "summary": "Call API Tool with JMESPath Query", "description": "Call an Equinix API tool and return only what a JMESPath query selects from its response. Use this instead of call_tool when a response would be large and only some fields are needed. The query runs on the API response body, whose shape is the tool's output schema (get_tool_schema with output_schema true). Query syntax: https://jmespath.org/specification.html\n\nExamples:\n- name \"fabric_getMetros\", arguments {\"limit\": 200}, query \"data[].{code: code, name: name, region: region}\"\n- name \"fabric_searchConnections\", query \"data[].{uuid: uuid, name: name, state: operation.equinixStatus}\"\n- query \"data[?region=='EMEA'].code\" to filter\n- query \"pagination.total\" to count results", "tags": [ { "name": "api" } ], "paramStructure": "by-name", "params": [ { "name": "name", "description": "Name of the API tool to call, as returned by search_tools, e.g. \"fabric_getMetros\"", "required": true, "schema": { "description": "Name of the API tool to call, as returned by search_tools, e.g. \"fabric_getMetros\"", "type": "string" } }, { "name": "query", "description": "JMESPath query applied to the API response body, e.g. \"data[].{code: code, name: name}\"", "required": true, "schema": { "description": "JMESPath query applied to the API response body, e.g. \"data[].{code: code, name: name}\"", "type": "string" } }, { "name": "arguments", "description": "Arguments for the API tool, as for call_tool", "required": false, "schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "description": "Arguments for the API tool, as for call_tool" } } ], "result": { "name": "call_api_filteredResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } } }, { "name": "crossconnects_Order_cross_connects", "summary": "Order cross connects", "description": "This method creates an order for single or multiple standard cross connects at locations where a user has cross connects ordering permission.\n\nPart of the Equinix Cross Connect API family (crossconnects). Order and manage physical cross connects between colocation deployments.", "tags": [ { "name": "crossconnects" }, { "name": "Cross Connects" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "customerReferenceId", "description": "Customer Reference Identifier / External Reference Identifier", "required": false, "schema": { "maxLength": 40, "minLength": 1, "type": "string", "description": "Customer Reference Identifier / External Reference Identifier", "example": "048837d6-4cd8-401f-ba41-a4ac015c3f3e" } }, { "name": "attachments", "description": "File(s) attached to the Cross Connect", "required": false, "schema": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_7dcbc88d" }, "description": "File(s) attached to the Cross Connect" } }, { "name": "description", "description": "Description of Cross Connect", "required": false, "schema": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "Description of Cross Connect", "example": "Any additonal details the technician may need to complete your request" } }, { "name": "expediteDateTime", "description": "Expedite orders are delivered within the next 2 - 24 hours. Value must be in ISO-8601 UTC timezone format.", "required": false, "schema": { "type": "string", "description": "Expedite orders are delivered within the next 2 - 24 hours. Value must be in ISO-8601 UTC timezone format.", "format": "date-time", "example": "2020-05-22T19:23:51.000Z" } }, { "name": "details", "description": "Cross connections details", "required": false, "schema": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "required": [ "aSide", "zSide" ], "type": "object", "properties": { "aSide": { "required": [ "patchPanel", "connectionService", "mediaType", "protocolType", "connectorType" ], "type": "object", "properties": { "patchPanel": { "$ref": "#/components/schemas/PatchPanel_06ef935c" }, "connectionService": { "enum": [ "COAX", "MP4_CABLE", "MULTI_MODE_FIBER", "POTS", "SINGLE_MODE_FIBER", "UTP" ], "type": "string", "description": "The name of the available connection service.", "example": "SINGLE_MODE_FIBER" }, "mediaType": { "enum": [ "COAX", "MP4_CABLE", "50_MICRON_MULTI_MODE_FIBER", "50_MICRON_MULTI_MODE_FIBER_OM2", "50_MICRON_MULTI_MODE_FIBER_OM3", "50_MICRON_MULTI_MODE_FIBER_OM4", "62.5_MICRON_MULTI_MODE_FIBER", "62.5_MICRON_MULTI_MODE_FIBER_OM1", "ABAM", "CAT3", "CAT5E", "CAT6", "CAT6A", "OS1", "SINGLE_MODE_FIBER" ], "type": "string", "description": "Name of media type.", "example": "SINGLE_MODE_FIBER" }, "protocolType": { "enum": [ "ANTENNA", "DS-3", "E1", "E3", "ETHERNET", "FAST_ETHERNET", "GIGABIT_ETHERNET", "POTS", "T1", "FIBRE_CHANNEL", "10_GIG_ETHERNET", "100_GIG_ETHERNET", "40_GIG_ETHERNET", "DARK_FIBER", "DWDM", "56K", "ISDN", "OC-12", "OC-192", "OC-3", "OC-48", "STM-1", "STM-16", "STM-4", "STM-64", "NA" ], "type": "string", "description": "Name of protocol type.", "example": "FAST_ETHERNET" }, "connectorType": { "enum": [ "BNC", "LC", "FC", "SC", "ST", "WIRE_WRAP", "RJ45", "E2000", "RJ11" ], "type": "string", "description": "Name of connector type.", "example": "LC" }, "mediaConverterRequired": { "type": "boolean", "description": "When `false`, Equinix will not proceed with cross connect installation that requires media conversion" }, "ifcCircuitCount": { "maximum": 48.0, "minimum": 1.0, "type": "integer", "description": "Use this field to request an intra-facility cable IFC with this order. Note that there might be a delay in fulfilment of Cross Connect as it is pending intra facility cabling", "example": 4 }, "patchEquipment": { "$ref": "#/components/schemas/PatchEquipment" } }, "description": "A-Side source patch panel to establish connection to another customer. Connections Service , Media Type and Protocol Type is mandatory to establish new connection. " }, "zSide": { "type": "object", "properties": { "notificationEmail": { "type": "string", "description": "Z-Side customer will be notified when cross connect is complete via specified email address", "example": "firstname.lastname@company.com" } }, "description": "Z-Side can be an existing or a new customer without patch panel. For an existing customer, only `patchPanel` and `connectorType` are required. For a new customer or patch panel, `providerName`, `ibx`, and `loaAttachmentId` are required", "anyOf": [ { "required": [ "loaAttachmentId", "ibx", "providerName" ], "type": "object", "properties": { "loaAttachmentId": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Attachment ID of Letter of Authorization (LOA). Refer to Attachment API to upload documents via API.", "example": "8d0bef9c-cca9-11ea-87d0-0242ac130003" }, "ibx": { "type": "string", "description": "IBX location code." }, "providerName": { "type": "string", "description": "Account name of service provider.", "example": "Carigan Communications " } } }, { "required": [ "patchPanel", "connectorType" ], "type": "object", "properties": { "connectorType": { "enum": [ "BNC", "LC", "FC", "SC", "ST", "WIRE_WRAP", "RJ45", "E2000", "RJ11" ], "type": "string", "description": "Name of connector type.", "example": "LC" }, "patchPanel": { "$ref": "#/components/schemas/PatchPanel_06ef935c" }, "circuitId": { "minLength": 1, "type": "string", "description": "Customer or carrier circuit ID cable reference number for verification purposes." } } } ] }, "diverseConnections": { "type": "object", "properties": { "type": { "enum": [ "NEW", "EXISTING" ], "type": "string", "description": "Redundant connection with existing connections or new connections", "default": "EXISTING" }, "serialNumber": { "type": "string", "description": "The serial number of Cross Connect is expecting when Diversified connection required from a previously provisioned connection" }, "aSide": { "type": "object", "properties": { "patchPanel": { "$ref": "#/components/schemas/PatchPanel_06ef935c" }, "connectorType": { "enum": [ "BNC", "LC", "FC", "SC", "ST", "WIRE_WRAP", "RJ45", "E2000", "RJ11" ], "type": "string", "description": "Name of connector type.", "example": "LC" }, "mediaConverterRequired": { "type": "boolean", "description": "ASide media Converter Required", "default": false }, "ifcCircuitCount": { "maximum": 48.0, "minimum": 1.0, "type": "integer", "description": "Use this field to request an intra-facility cable IFC with this order. Note that there might be a delay in fulfilment of Cross Connect as it is pending intra facility cabling", "example": 4 }, "patchEquipment": { "$ref": "#/components/schemas/PatchEquipment" } } }, "zSide": { "type": "object", "properties": { "patchPanel": { "$ref": "#/components/schemas/PatchPanel_06ef935c" }, "connectorType": { "enum": [ "BNC", "LC", "FC", "SC", "ST", "WIRE_WRAP", "RJ45", "E2000", "RJ11" ], "type": "string", "description": "Name of connector type.", "example": "LC" }, "circuitId": { "minLength": 1, "type": "string", "description": "Unique Circut ID for future reference", "example": "100931" } } } }, "description": "Diversified cross connect or redundant cross connect for the availability. If its a new redundant connection, A-Side and Z-Side is mandatory. If it is existing connection, Cross Connect serial number and type is mandatory." }, "verifyLink": { "type": "boolean", "description": "When `true`, light link verification is carried out. This may incur fixed fee based on your contract pricing." }, "circuitDeliveryDate": { "type": "string", "description": "Carrier Circuit Delivery Date", "format": "date", "example": "2020-05-22T00:00:00.000Z" }, "submarineEngineerRequired": { "type": "boolean", "description": "Set to `true` if submarine cable station engineer is required.", "default": false } } }, "description": "Cross connections details" } }, { "name": "purchaseOrder", "description": "Purchase Order", "required": false, "schema": { "$ref": "#/components/schemas/PurchaseOrder_d179fb3a" } }, { "name": "contacts", "required": false, "schema": { "$ref": "#/components/schemas/Contacts_4a0177e7" } } ], "result": { "name": "crossconnects_Order_cross_connectsResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Order cross connects", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "crossconnects_Place_cross_connect_deinstallation_order", "summary": "Place cross connect deinstallation order", "description": "This API allows user to initiate a cross connect deinstallation request. Cross connect asset will be removed according to order placed.\n\nPart of the Equinix Cross Connect API family (crossconnects). Order and manage physical cross connects between colocation deployments.", "tags": [ { "name": "crossconnects" }, { "name": "Cross Connects" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "customerReferenceId", "description": "Customer Reference Identifier / External Reference Identifier", "required": false, "schema": { "maxLength": 40, "minLength": 1, "type": "string", "description": "Customer Reference Identifier / External Reference Identifier" } }, { "name": "purchaseOrder", "description": "Purchase Order", "required": false, "schema": { "$ref": "#/components/schemas/PurchaseOrder_d179fb3a" } }, { "name": "contacts", "required": false, "schema": { "$ref": "#/components/schemas/Contacts_4a0177e7" } }, { "name": "attachments", "description": "File(s) attached to the layer #1 connections", "required": false, "schema": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_7dcbc88d" }, "description": "File(s) attached to the layer #1 connections" } }, { "name": "description", "description": "Description of deinstallation", "required": false, "schema": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "Description of deinstallation", "example": "Any additonal details the technician may need to complete your request" } }, { "name": "details", "description": " layer #1 connections details", "required": false, "schema": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "required": [ "assetId" ], "type": "object", "properties": { "assetId": { "type": "string", "description": "Asset ID of the cross connect you wish to de-install", "example": "4-1234567890" }, "proceedWithLiveTraffic": { "type": "boolean", "description": "When `true`, Equinix will proceed with deinstallation request despite detecting live traffic.", "example": false }, "patchEquipment": { "required": [ "cabinetId", "details", "port" ], "type": "object", "properties": { "cabinetId": { "type": "string", "description": "The cabinet to remove patch cable from", "example": "CH3:01:123456:0000" }, "details": { "type": "string", "description": "Provide additional information to facilitate patch equipment removal", "example": "Patch cable for this port" }, "port": { "minimum": 1.0, "type": "number", "description": "Device port number to be removed", "example": 12 } } } } }, "description": " layer #1 connections details" } }, { "name": "removalDate", "description": "Equinix will aim to terminate this Cross Connect at this date subjected to operation availability.", "required": false, "schema": { "type": "string", "description": "Equinix will aim to terminate this Cross Connect at this date subjected to operation availability.", "format": "date", "example": "2022-11-23" } } ], "result": { "name": "crossconnects_Place_cross_connect_deinstallation_orderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Place cross connect deinstallation order", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "crossconnects_Update_a_Cross_Connect_Order", "summary": "Update a cross connects order", "description": "This method updates a cross connects order by its ID for a user with permission to view this request.\n\nPart of the Equinix Cross Connect API family (crossconnects). Order and manage physical cross connects between colocation deployments.", "tags": [ { "name": "crossconnects" }, { "name": "Cross Connects" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the cross connect order", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Identifier of the cross connect order" } }, { "name": "contacts", "required": false, "schema": { "$ref": "#/components/schemas/Contacts_d5d3518a" } } ], "result": { "name": "crossconnects_Update_a_Cross_Connect_OrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update a cross connects order", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "diloa_cancelByUuid", "summary": "Delete Digital LOA document", "description": "Invalidates a specified Digital LOA document and sets its status to CANCELLED.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Loa" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Digital LOA document identifier.", "required": true, "schema": { "type": "string", "example": "079dc798-05e8-11ed-b939-0242ac120002", "description": "Digital LOA document identifier." } } ], "result": { "name": "diloa_cancelByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Digital LOA document", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_create", "summary": "Create Digital LOA document", "description": "Creates a Digital LOA document.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Loa" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "products", "description": "Specification of services that the given LOA document is valid for.", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "required": [ "crossConnect", "type" ], "type": "object", "properties": { "type": { "enum": [ "CROSS_CONNECT" ], "type": "string", "description": "Product type.", "example": "CROSS_CONNECT" }, "crossConnect": { "required": [ "connectionService", "mediaType", "protocolType", "zSide" ], "type": "object", "properties": { "connectionService": { "type": "string", "description": "Connection service type. For applicable values, use the Equinix Customer Portal - Lookup - Get Patch Panel Details API request.", "example": "MULTI_MODE_FIBER" }, "mediaType": { "type": "string", "description": "Media type. For applicable values, use the Equinix Customer Portal - Lookup - Get Patch Panel Details API request.", "example": "50_MICRON_MULTI_MODE_FIBER_OM3" }, "protocolType": { "type": "string", "description": "Connection protocol. For applicable values, use the Equinix Customer Portal - Lookup - Get Patch Panel Details API request.", "example": "100_GIG_ETHERNET" }, "aSide": { "$ref": "#/components/schemas/ASide_df14dd5d" }, "zSide": { "$ref": "#/components/schemas/ASide_df14dd5d" } }, "description": "Create Cross Connect interface" } }, "description": "Product interface" }, "description": "Specification of services that the given LOA document is valid for." } }, { "name": "requestor", "description": "Party interface for Customer Organization", "required": true, "schema": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NEW_RELATIONSHIP", "CUSTOMER_ORGANIZATION" ], "type": "string", "description": "Party type", "example": "CUSTOMER_ORGANIZATION" } }, "description": "Party interface for Customer Organization" } }, { "name": "provider", "description": "Party contacts", "required": true, "schema": { "$ref": "#/components/schemas/Provider" } }, { "name": "notes", "description": "Additional information, added to the Digital LOA document, that should be taken under consideration.", "required": false, "schema": { "type": "string", "description": "Additional information, added to the Digital LOA document, that should be taken under consideration.", "example": "Rack access: weekdays - 18:00 to 22:00 CET; Saturday - 10:00 to 14:00 CET." } }, { "name": "expiryDateTime", "description": "Digital LOA expiration date.", "required": false, "schema": { "type": "string", "description": "Digital LOA expiration date.", "format": "date-time", "example": "2022-11-17T22:59:59.999000Z" } } ], "result": { "name": "diloa_createResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "User-friendly Digital LOA document identifier.", "example": "REDF-4R56" }, "uuid": { "type": "string", "description": "Digital LOA document identifier.", "format": "uuid", "example": "079dc798-05e8-11ed-b939-0242ac120002" }, "state": { "enum": [ "READY_FOR_USE", "LOCKED", "USED", "CANCELLED", "EXPIRED", "PENDING_REQUESTOR_ACCEPTANCE", "PENDING_PROVIDER_AUTHORIZATION" ], "type": "string", "description": "Digital LOA document status.", "example": "USED" }, "draft": { "type": "boolean", "description": "Default: false", "example": false }, "changeLog": { "type": "object", "properties": { "createdDateTime": { "type": "string", "description": "Date and time of Digital LOA document creation.", "format": "date-time", "example": "2022-11-17T22:59:59.999000Z" } }, "description": "Change interface" }, "links": { "$ref": "#/components/schemas/Links_459c701e" }, "change": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Digital LOA document identifier.", "format": "uuid", "example": "079dc798-05e8-11ed-b939-0242ac120002" }, "href": { "type": "string", "description": "Digital LOA document URI.", "example": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a" }, "type": { "enum": [ "LOA_CREATION", "LOA_UPDATE" ], "type": "string", "description": "Operation type.", "example": "LOA_UPDATE" } }, "description": "Change interface" }, "expiryDateTime": { "type": "string", "description": "Digital LOA document expiration date.", "format": "date-time", "example": "2022-11-17T22:59:59.999000Z" }, "href": { "type": "string", "description": "Digital LOA document URI.", "example": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a" } }, "description": "Created Digital Letter of Authorization", "x-fastmcp-top-level-schema": "LoaBasic" } }, "x-mcp-annotations": { "title": "Create Digital LOA document", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "diloa_createPrivateBetaAccessRequest", "summary": "Create private beta access request", "description": "Creates a request for an access to private beta Digital LOA Manager.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Private Beta Access" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "email", "description": "Email of the user submitting a request.", "required": true, "schema": { "type": "string", "description": "Email of the user submitting a request.", "format": "email", "example": "kyle@mail.com" } }, { "name": "companyName", "description": "Name of the company of user submitting a request.", "required": true, "schema": { "type": "string", "description": "Name of the company of user submitting a request.", "example": "XYZ Inc." } } ], "result": { "name": "diloa_createPrivateBetaAccessRequestResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Create private beta access request", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "diloa_createRequest", "summary": "Create Digital LOA Request", "description": "Creates a Digital LOA request.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "LoaRequests" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "ibx", "description": "IBX data center identifier.", "required": true, "schema": { "type": "string", "description": "IBX data center identifier.", "example": "CH1" } }, { "name": "requestedNumber", "description": "Number of requested connections.", "required": true, "schema": { "type": "integer", "description": "Number of requested connections.", "example": 2 } }, { "name": "requestor", "description": "Party contacts", "required": true, "schema": { "$ref": "#/components/schemas/Provider" } }, { "name": "provider", "description": "Party interface for Customer Organization", "required": true, "schema": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NEW_RELATIONSHIP", "CUSTOMER_ORGANIZATION" ], "type": "string", "description": "Party type", "example": "CUSTOMER_ORGANIZATION" } }, "description": "Party interface for Customer Organization" } }, { "name": "notes", "description": "Additional information to be considered.", "required": false, "schema": { "type": "string", "description": "Additional information to be considered.", "example": "Please contact me" } } ], "result": { "name": "diloa_createRequestResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Create Digital LOA Request", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "diloa_findByUuid", "summary": "Get specified Digital LOA document.", "description": "Returns details of a specified Digital LOA document.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Loa" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Digital LOA document identifier.", "required": true, "schema": { "type": "string", "example": "079dc798-05e8-11ed-b939-0242ac120002", "description": "Digital LOA document identifier." } } ], "result": { "name": "diloa_findByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Diloa_findByUuidResult" } }, "x-mcp-annotations": { "title": "Get specified Digital LOA document.", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_findChangeByUuid", "summary": "Get specified Digital LOA change", "description": "Returns details of a specified Digital LOA change.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "LoaChanges" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Digital LOA unique identifier.", "required": true, "schema": { "type": "string", "example": "079dc798-05e8-11ed-b939-0242ac120002", "description": "Digital LOA unique identifier." } }, { "name": "changeUuid", "description": "Digital LOA change unique identifier.", "required": true, "schema": { "type": "string", "example": "4c7d67e2-bbf2-4407-bcff-05a385ed0d4e", "description": "Digital LOA change unique identifier." } } ], "result": { "name": "diloa_findChangeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "createdDateTime": { "type": "string", "description": "Date and time of Digital LOA change creation.", "format": "date-time", "example": "2021-11-17T22:59:59.999000Z" }, "updatedDateTime": { "type": "string", "description": "Date and time of Digital LOA change update.", "format": "date-time", "example": "2021-11-17T22:59:59.999000Z" }, "data": { "type": "string", "description": "Changes to Digital LOA according to JSON representation.", "example": "{\"type\": \"ACCEPT\"}" }, "description": { "type": "string", "description": "Additional Digital LOA change information.", "example": "Create Loa" }, "href": { "type": "string", "description": "Digital LOA document URI.", "example": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a" }, "links": { "$ref": "#/components/schemas/Links_459c701e" }, "type": { "enum": [ "LOA_CREATION", "LOA_AUTHORIZATION", "LOA_CANCELLATION", "LOA_PATCHING", "LOA_LOCK_ACQUISITION", "LOA_LOCK_RELEASE", "LOA_USAGE", "LOA_ACCEPTANCE", "LOA_UNAUTHORIZATION", "LOA_EXPIRATION", "TYPE_UNKNOWN" ], "type": "string", "description": "Digital LOA change type.", "example": "LOA_CREATION" }, "uuid": { "type": "string", "description": "Digital LOA change unique identifier.", "format": "uuid", "example": "4c7d67e2-bbf2-4407-bcff-05a385ed0d4e" }, "status": { "enum": [ "REQUESTED", "COMPLETED", "FAILED" ], "type": "string", "description": "Digital LOA change status.", "example": "COMPLETED" }, "result": { "$ref": "#/components/schemas/Result_134b2236" } }, "description": "LOA change record", "x-fastmcp-top-level-schema": "LoaChange" } }, "x-mcp-annotations": { "title": "Get specified Digital LOA change", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_findChangesByLoaUuid", "summary": "Get specified Digital LOA changes", "description": "Returns a set of Digital LOA changes.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "LoaChanges" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Digital LOA unique identifier.", "required": true, "schema": { "type": "string", "example": "079dc798-05e8-11ed-b939-0242ac120002", "description": "Digital LOA unique identifier." } } ], "result": { "name": "diloa_findChangesByLoaUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "createdDateTime": { "type": "string", "description": "Date and time of Digital LOA change creation.", "format": "date-time", "example": "2021-11-17T22:59:59.999000Z" }, "updatedDateTime": { "type": "string", "description": "Date and time of Digital LOA change update.", "format": "date-time", "example": "2021-11-17T22:59:59.999000Z" }, "data": { "type": "string", "description": "Changes to Digital LOA according to JSON representation.", "example": "{\"type\": \"ACCEPT\"}" }, "description": { "type": "string", "description": "Additional Digital LOA change information.", "example": "Create Loa" }, "href": { "type": "string", "description": "Digital LOA document URI.", "example": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a" }, "links": { "$ref": "#/components/schemas/Links_459c701e" }, "type": { "enum": [ "LOA_CREATION", "LOA_AUTHORIZATION", "LOA_CANCELLATION", "LOA_PATCHING", "LOA_LOCK_ACQUISITION", "LOA_LOCK_RELEASE", "LOA_USAGE", "LOA_ACCEPTANCE", "LOA_UNAUTHORIZATION", "LOA_EXPIRATION", "TYPE_UNKNOWN" ], "type": "string", "description": "Digital LOA change type.", "example": "LOA_CREATION" }, "uuid": { "type": "string", "description": "Digital LOA change unique identifier.", "format": "uuid", "example": "4c7d67e2-bbf2-4407-bcff-05a385ed0d4e" }, "status": { "enum": [ "REQUESTED", "COMPLETED", "FAILED" ], "type": "string", "description": "Digital LOA change status.", "example": "COMPLETED" }, "result": { "$ref": "#/components/schemas/Result_134b2236" } }, "description": "LOA change record" }, "description": "Digital LOA change list", "x-fastmcp-top-level-schema": "LoaChangeList" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get specified Digital LOA changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_findOrganizations", "summary": "Marketplace organizations selection", "description": "Search organizations available in a given IBX data center.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Marketplace Organizations" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "location.ibx", "description": "IBX data center identifier.", "required": true, "schema": { "type": "string", "example": "AM11", "description": "IBX data center identifier." } }, { "name": "product.type", "description": "Product types.", "required": false, "schema": { "type": "array", "items": { "enum": [ "CROSS_CONNECT" ], "type": "string", "example": "CROSS_CONNECT" }, "default": [ "CROSS_CONNECT" ], "description": "Product types." } } ], "result": { "name": "diloa_findOrganizationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "orgIds": { "type": "array", "items": { "type": "string", "description": "Organization identifier.", "example": "7436" }, "description": "Organization identifiers." }, "name": { "type": "string", "description": "Organization name", "example": "XYZ Inc." } }, "description": "Customer organization" }, "description": "Customer Organization List", "x-fastmcp-top-level-schema": "CustomerOrganizations" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Marketplace organizations selection", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_getBetaTermsAgreement", "summary": "Get beta terms agreement", "description": "Returns information whether the user has accepted beta terms agreement.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "User Profile" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [], "result": { "name": "diloa_getBetaTermsAgreementResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "agreementAccepted": { "type": "boolean", "description": "User-accepted beta terms.", "example": true } }, "description": "Beta Terms Agreement", "x-fastmcp-top-level-schema": "BetaTermsAgreement" } }, "x-mcp-annotations": { "title": "Get beta terms agreement", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_isPrivateBetaAllowed", "summary": "Check private beta permission", "description": "Checks if the user is authorized to use Digital LOA Manager private beta.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Private Beta Access" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [], "result": { "name": "diloa_isPrivateBetaAllowedResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "privateBetaTests": { "type": "boolean", "description": "Defines if the user is allowed to use application in the private beta phase.", "example": true } }, "description": "Private beta permission", "x-fastmcp-top-level-schema": "PrivateBetaPermission" } }, "x-mcp-annotations": { "title": "Check private beta permission", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_patchByUuid", "summary": "Modify a Digital LOA document", "description": "Modifies a given Digital LOA document.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Loa" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Digital LOA document identifier.", "required": true, "schema": { "type": "string", "example": "079dc798-05e8-11ed-b939-0242ac120002", "description": "Digital LOA document identifier." } }, { "name": "body", "description": "Patch Object", "required": true, "schema": { "type": "array", "items": { "required": [ "op", "path" ], "type": "object", "properties": { "op": { "enum": [ "add", "remove", "replace", "move", "copy", "test" ], "type": "string", "description": "The operation to be performed", "example": "replace" }, "path": { "enum": [ "/state", "/requestor/contacts" ], "type": "string", "description": "A path to property being patched", "example": "/state" }, "value": { "type": "object", "description": "The value to be used within the operations." }, "from": { "type": "string", "description": "A string containing a JSON Pointer value.", "example": "READY_FOR_USE" } }, "description": "A JSONPatch document as defined by RFC 6902" }, "description": "Patch Object" } } ], "result": { "name": "diloa_patchByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Diloa_findByUuidResult" } }, "x-mcp-annotations": { "title": "Modify a Digital LOA document", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "diloa_performAction", "summary": "Perform action on Digital LOA document.", "description": "Performs an action on a given Digital LOA document.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Loa" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Digital LOA document identifier.", "required": true, "schema": { "type": "string", "example": "079dc798-05e8-11ed-b939-0242ac120002", "description": "Digital LOA document identifier." } }, { "name": "type", "description": "Action type performed on a Digital LOA document.\n * `ACCEPT` - Accepts Digital LOA Requestor as a valid Equinix customer\n * `AUTHORIZE` - Authorizes Requestor as a party of Digital LOA by its Provider\n * `UNAUTHORIZE` - Unauthorizes Requestor as a party of LOA by its Provider\n * `SEND_LOA` - Sends emails with Digital LOA details\n Selects the variant. Accepted values: 'ACCEPT', 'AUTHORIZE', 'UNAUTHORIZE', 'SEND_LOA'.", "required": true, "schema": { "enum": [ "ACCEPT", "AUTHORIZE", "UNAUTHORIZE", "SEND_LOA" ], "type": "string", "description": "Action type performed on a Digital LOA document.\n * `ACCEPT` - Accepts Digital LOA Requestor as a valid Equinix customer\n * `AUTHORIZE` - Authorizes Requestor as a party of Digital LOA by its Provider\n * `UNAUTHORIZE` - Unauthorizes Requestor as a party of LOA by its Provider\n * `SEND_LOA` - Sends emails with Digital LOA details\n Selects the variant. Accepted values: 'ACCEPT', 'AUTHORIZE', 'UNAUTHORIZE', 'SEND_LOA'.", "example": "ACCEPT" } } ], "result": { "name": "diloa_performActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Diloa_findByUuidResult" } }, "x-mcp-annotations": { "title": "Perform action on Digital LOA document.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "diloa_search", "summary": "Retrieve Digital LOA Documents", "description": "Returns Digital LOA documents that match the specified criteria.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "Loa" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "description": "Search criteria body", "required": true, "schema": { "required": [ "and" ], "type": "object", "properties": { "and": { "minItems": 1, "type": "array", "items": { "type": "object", "description": "AND or OR expression type.", "anyOf": [ { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/components/schemas/OrItem" }, "description": "Search criterion item displaying a record if any of the conditions separated by 'or' is true" } }, "description": "Search criterion" }, { "$ref": "#/components/schemas/OrItem" } ] }, "description": "Search criterion list" } }, "description": "Search criteria body" } }, { "name": "offset", "description": "Index of the first item returned in the response.", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Index of the first item returned in the response." } }, { "name": "limit", "description": "Maximum number of items returned per page.", "required": false, "schema": { "minimum": 1.0, "type": "integer", "default": 20, "example": 20, "description": "Maximum number of items returned per page." } }, { "name": "sort", "description": "Search results sorting settings:\n * `/` - Ascending, i.e. '/expiryDateTime'\n * `-/` - Descending, i.e. '-/expiryDateTime'\n", "required": false, "schema": { "type": "array", "items": { "enum": [ "/changeLog/createdDateTime", "-/changeLog/createdDateTime", "/expiryDateTime", "-/expiryDateTime", "/products/zSide/patchPanel/location/ibx", "-/products/zSide/patchPanel/location/ibx" ], "type": "string", "example": "/expiryDateTime" }, "description": "Search results sorting settings:\n * `/` - Ascending, i.e. '/expiryDateTime'\n * `-/` - Descending, i.e. '-/expiryDateTime'\n" } } ], "result": { "name": "diloa_searchResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination", "sort" ], "type": "object", "properties": { "pagination": { "required": [ "limit", "offset", "total" ], "type": "object", "properties": { "offset": { "type": "integer", "description": "Index of the first item returned in the response.", "example": 0 }, "limit": { "type": "integer", "description": "Maximum number of items returned per page.", "example": 500 }, "total": { "type": "integer", "description": "Total number of items returned.", "example": 900 }, "next": { "type": "string", "description": "Link to the next page of the collection", "example": "/diloa/v1/digitalLoas?offset=10&limit=20" }, "previous": { "type": "string", "description": "Link to the previous page of the collection", "example": "/diloa/v1/digitalLoas?offset=0&limit=20" } }, "description": "Pagination" }, "sort": { "type": "array", "items": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "enum": [ "ASC", "DESC" ], "type": "string", "description": "Search results sorting direction.", "example": "ASC" }, "property": { "enum": [ "/changeLog/createdDateTime", "/expiryDateTime", "/products/zSide/patchPanel/location/ibx" ], "type": "string", "description": "Search results sorting parameter.", "example": "/expiryDateTime" } }, "description": "Sort" }, "description": "Search results sorting settings." }, "data": { "type": "array", "items": { "type": "object", "properties": { "token": { "type": "string", "description": "User-friendly Digital LOA document identifier.", "example": "REDF-4R56" }, "uuid": { "type": "string", "description": "Digital LOA document identifier.", "format": "uuid", "example": "079dc798-05e8-11ed-b939-0242ac120002" }, "state": { "enum": [ "READY_FOR_USE", "LOCKED", "USED", "CANCELLED", "EXPIRED", "PENDING_REQUESTOR_ACCEPTANCE", "PENDING_PROVIDER_AUTHORIZATION" ], "type": "string", "description": "Digital LOA document status.", "example": "USED" }, "products": { "$ref": "#/components/schemas/Products" }, "requestor": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NEW_RELATIONSHIP", "CUSTOMER_ORGANIZATION" ], "type": "string", "description": "Party type", "example": "CUSTOMER_ORGANIZATION" } }, "description": "Party interface for Customer Organization" }, "provider": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NEW_RELATIONSHIP", "CUSTOMER_ORGANIZATION" ], "type": "string", "description": "Party type", "example": "CUSTOMER_ORGANIZATION" } }, "description": "Party interface for Customer Organization" }, "changeLog": { "type": "object", "properties": { "createdDateTime": { "type": "string", "description": "Date and time of Digital LOA document creation.", "format": "date-time", "example": "2022-11-17T22:59:59.999000Z" } }, "description": "Change interface" }, "links": { "$ref": "#/components/schemas/Links_459c701e" }, "notes": { "type": "string", "description": "Additional information to be considered.", "example": "Please contact me" }, "expiryDateTime": { "type": "string", "description": "Digital LOA document expiration date.", "format": "date-time", "example": "2022-11-17T22:59:59.999000Z" }, "href": { "type": "string", "description": "Digital LOA document URI.", "example": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a" } }, "description": "Digital Letter of Authorization" }, "description": "Data set containing Digital LOA documents." } }, "description": "Pageable Letter of Authorization list", "x-fastmcp-top-level-schema": "PageableAndSortableLoa" } }, "x-mcp-annotations": { "title": "Retrieve Digital LOA Documents", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "diloa_updateBetaTermsAgreement", "summary": "Update beta terms agreement", "description": "Updates beta terms agreement for current user.\n\nPart of the Equinix Digital LOA API family (diloa). Digital Letter of Authorization (LOA): authorize cross connect and interconnection provisioning.", "tags": [ { "name": "diloa" }, { "name": "User Profile" }, { "name": "colocation" }, { "name": "interconnection" } ], "paramStructure": "by-name", "params": [ { "name": "agreementAccepted", "description": "User-accepted beta terms.", "required": false, "schema": { "type": "boolean", "description": "User-accepted beta terms.", "example": true } } ], "result": { "name": "diloa_updateBetaTermsAgreementResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "agreementAccepted": { "type": "boolean", "description": "User-accepted beta terms.", "example": true } }, "description": "Beta Terms Agreement", "x-fastmcp-top-level-schema": "BetaTermsAgreement" } }, "x-mcp-annotations": { "title": "Update beta terms agreement", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_addToLag", "summary": "Add to Lag", "description": "Add Physical Ports to Virtual Port. Preview\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "portId", "description": "Port UUID", "required": true, "schema": { "type": "string", "description": "Port UUID", "format": "uuid" } }, { "name": "data", "description": "add physical ports to virtual port", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_59eff7ff" }, "description": "add physical ports to virtual port" } } ], "result": { "name": "fabric_addToLagResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_59eff7ff" }, "description": "GET All Physical Ports" } }, "description": "GET All Physical Ports", "x-fastmcp-top-level-schema": "AllPhysicalPortsResponse" } }, "x-mcp-annotations": { "title": "Add to Lag", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_attachAppDomainToAppLink", "summary": "Attach Domain to Link", "description": "This API provides ability to attach the user's App Domain to App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appDomainId", "description": "App Domain UUID", "required": true, "schema": { "type": "string", "description": "App Domain UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } } ], "result": { "name": "fabric_attachAppDomainToAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppDomainToAppLinkResult" } }, "x-mcp-annotations": { "title": "Attach Domain to Link", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_attachAppProcessorToAppLink", "summary": "Attach Processor to Link", "description": "This API provides ability to attach an App Processor to an App Link.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appProcessorId", "description": "App Processor UUID", "required": true, "schema": { "type": "string", "description": "App Processor UUID", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f" } }, { "name": "config", "description": "Base64-encoded configuration for the processor attachment", "required": true, "schema": { "type": "string", "description": "Base64-encoded configuration for the processor attachment", "format": "byte", "example": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA..." } } ], "result": { "name": "fabric_attachAppProcessorToAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppProcessorToAppLinkResult" } }, "x-mcp-annotations": { "title": "Attach Processor to Link", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_attachAppServiceToAppLink", "summary": "Attach Service to Link", "description": "This API provides ability to attach the user's App Service to App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "geoScope", "description": "Geo scope for the App Service", "required": true, "schema": { "type": "string", "description": "Geo scope for the App Service", "example": "GLOBAL" } }, { "name": "destinationIp", "description": "Target IP for forwarding API requests", "required": true, "schema": { "type": "string", "description": "Target IP for forwarding API requests", "format": "ipv4", "example": "10.10.1.110" } } ], "result": { "name": "fabric_attachAppServiceToAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppServiceToAppLinkResult" } }, "x-mcp-annotations": { "title": "Attach Service to Link", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_attachConnectionRouteAggregation", "summary": "Attach Aggregation", "description": "This API provides capability to attach a Route Aggregation to a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_attachConnectionRouteAggregationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachConnectionRouteAggregationResult" } }, "x-mcp-annotations": { "title": "Attach Aggregation", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_attachConnectionRouteFilter", "summary": "Attach Route Filter", "description": "This API provides capability to attach a Route Filter to a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "direction", "description": "Route Filter direction to attach to a connection", "required": true, "schema": { "enum": [ "INBOUND", "OUTBOUND" ], "type": "string", "description": "Route Filter direction to attach to a connection" } } ], "result": { "name": "fabric_attachConnectionRouteFilterResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachConnectionRouteFilterResult" } }, "x-mcp-annotations": { "title": "Attach Route Filter", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_attachPrivateServiceToProfile", "summary": "Attach Private Service", "description": "Attach a private service to a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } }, { "name": "privateServiceId", "description": "Private Service UUID", "required": true, "schema": { "type": "string", "description": "Private Service UUID" } } ], "result": { "name": "fabric_attachPrivateServiceToProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachPrivateServiceToProfileResult" } }, "x-mcp-annotations": { "title": "Attach Private Service", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_attachServiceProfileToProfile", "summary": "Attach Service Profile", "description": "Attach a service profile to a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } }, { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID" } } ], "result": { "name": "fabric_attachServiceProfileToProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachServiceProfileToProfileResult" } }, "x-mcp-annotations": { "title": "Attach Service Profile", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_attachTagToProfile", "summary": "Attach Tag", "description": "Attach a tag to a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } }, { "name": "tagId", "description": "Tag UUID", "required": true, "schema": { "type": "string", "description": "Tag UUID" } } ], "result": { "name": "fabric_attachTagToProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachTagToProfileResult" } }, "x-mcp-annotations": { "title": "Attach Tag", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_createAppDomain", "summary": "Create Domain", "description": "This API provides capability to create user's App Domain\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Domains" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "App Domain Type", "required": true, "schema": { "enum": [ "APP_DOMAIN" ], "type": "string", "description": "App Domain Type", "default": "APP_DOMAIN", "example": "APP_DOMAIN", "x-order": 2 } }, { "name": "name", "description": "Customer-provided App Domain name", "required": true, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Customer-provided App Domain name", "format": "string", "example": "atlassian.net" } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "description", "description": "Customer-provided App Domain description", "required": false, "schema": { "type": "string", "description": "Customer-provided App Domain description", "format": "string", "example": "Atlassian Domain" } } ], "result": { "name": "fabric_createAppDomainResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppDomainResult" } }, "x-mcp-annotations": { "title": "Create Domain", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createAppLink", "summary": "Create Link", "description": "This API provides capability to create user's Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "App Link Type", "required": true, "schema": { "enum": [ "APP_LINK" ], "type": "string", "description": "App Link Type", "default": "APP_LINK", "example": "APP_LINK", "x-order": 2 } }, { "name": "name", "description": "Customer-provided App Link name", "required": true, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Customer-provided App Link name", "format": "string", "example": "Atlassian App Link" } }, { "name": "router", "description": "Cloud Router reference for App Link", "required": true, "schema": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "36204584-2ae1-44f6-980f-08ecd555d9c6" } }, "description": "Cloud Router reference for App Link" } }, { "name": "ipv4Subnet", "description": "Customer-provided IP subnet for AppLink setup (/29 or larger subnet)", "required": true, "schema": { "type": "string", "description": "Customer-provided IP subnet for AppLink setup (/29 or larger subnet)", "example": "192.168.10.0/29" } }, { "name": "bandwidth", "description": "App Link aggregated data transfer capacity in Mbps", "required": true, "schema": { "type": "integer", "description": "App Link aggregated data transfer capacity in Mbps", "example": 1000 } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "description", "description": "Customer-provided App Link description", "required": false, "schema": { "type": "string", "description": "Customer-provided App Link description", "format": "string", "example": "Atlassian App Link in SV" } } ], "result": { "name": "fabric_createAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppLinkResult" } }, "x-mcp-annotations": { "title": "Create Link", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createAppService", "summary": "Create Service", "description": "This API provides capability to create user's Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "App Service Type", "required": true, "schema": { "enum": [ "APP_SERVICE" ], "type": "string", "description": "App Service Type", "default": "APP_SERVICE", "example": "APP_SERVICE", "x-order": 2 } }, { "name": "name", "description": "Customer-provided App Service name", "required": true, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Customer-provided App Service name", "format": "string", "example": "Atlassian App Service" } }, { "name": "endpoint", "description": "Accessible endpoint through this service", "required": true, "schema": { "type": "string", "description": "Accessible endpoint through this service", "example": "equinixjira.atlassian.net" } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "description", "description": "Customer-provided App Service description", "required": false, "schema": { "type": "string", "description": "Customer-provided App Service description", "format": "string", "example": "Atlassian App Service in SV" } }, { "name": "sourceDomains", "description": "List of source domains from where traffic is allowed", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "equinix.com" }, "description": "List of source domains from where traffic is allowed" } } ], "result": { "name": "fabric_createAppServiceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppServiceResult" } }, "x-mcp-annotations": { "title": "Create Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createAppSubscription", "summary": "Create Subscription", "description": "This API provides capability to create user's Subscription\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "App Subscription Type", "required": true, "schema": { "enum": [ "APP_SUBSCRIPTION" ], "type": "string", "description": "App Subscription Type", "default": "APP_SUBSCRIPTION", "example": "APP_SUBSCRIPTION", "x-order": 2 } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "source", "description": "Source details for the Subscription", "required": false, "schema": { "required": [ "ipSubnets" ], "type": "object", "properties": { "appLink": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, "description": "App Link reference for App Subscription" }, "ipSubnets": { "type": "array", "items": { "type": "string", "format": "ipv4-cidr", "example": "192.168.100.0/24" }, "description": "List of IP subnets in CIDR notation" } }, "description": "Source details for the Subscription", "x-order": 4 } }, { "name": "target", "description": "Target details for the Subscription", "required": false, "schema": { "required": [ "prioritization", "geoScope" ], "type": "object", "properties": { "appService": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "5008a109-9d1c-485c-b0ba-de9736f283c2" } }, "description": "App Service reference for App Subscription" }, "geoScope": { "type": "string", "description": "Geo scope", "example": "GLOBAL" }, "prioritization": { "enum": [ "LATENCY", "PERFORMANCE", "UTILIZATION", "THRESHOLD", "ANY_TAG" ], "type": "string", "description": "Prioritization strategy for forwarding API requests", "example": "LATENCY" } }, "description": "Target details for the Subscription", "x-order": 5 } } ], "result": { "name": "fabric_createAppSubscriptionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppSubscriptionResult" } }, "x-mcp-annotations": { "title": "Create Subscription", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createAsn", "summary": "Create ASN", "description": "Create a new Public or Private ASN record\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "ASNs" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "number", "description": "ASN number used for public ASN creation.", "required": false, "schema": { "type": "integer", "description": "ASN number used for public ASN creation.", "format": "int64", "example": 64497 } }, { "name": "rirRegion", "description": "Regional Internet Registry region", "required": false, "schema": { "enum": [ "AFRINIC", "APNIC", "ARIN", "LACNIC", "RIPE_NCC" ], "type": "string", "description": "Regional Internet Registry region" } }, { "name": "ownershipChallengeDetails", "description": "Ownership challenge details for public ASN verification", "required": false, "schema": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "RPKI", "LOA" ], "type": "string", "description": "Type of ownership challenge", "x-enum-varnames": [ "RPKI", "LOA" ] } }, "description": "Ownership challenge details for public ASN verification" } }, { "name": "location", "required": false, "schema": { "$ref": "#/components/schemas/Location_53f78db6" } }, { "name": "range", "description": "ASN range selection", "required": false, "schema": { "enum": [ "16_BIT", "32_BIT" ], "type": "string", "description": "ASN range selection" } } ], "result": { "name": "fabric_createAsnResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAsnResult" } }, "x-mcp-annotations": { "title": "Create ASN", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createBulkOpticalConnect", "summary": "Create Dual Diverse Optical Metro Connect Service", "description": "Create a dual diverse pair of circuits on separate optical paths.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Optical Metro Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "data", "description": "The two connections forming the diverse pair — one PRIMARY and one\n SECONDARY.\n", "required": false, "schema": { "type": "array", "items": { "required": [ "type", "bandwidth", "connectionDestinationType", "pathType", "aSide", "zSide" ], "type": "object", "properties": { "type": { "enum": [ "OC" ], "type": "string", "description": "OC - Optical Connect Type", "example": "OC" }, "bandwidth": { "type": "integer", "description": "Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.
\n", "example": 100000 }, "connectionDestinationType": { "$ref": "#/components/schemas/ConnectionDestinationType" }, "pathType": { "$ref": "#/components/schemas/PathType_63f97b0d" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_e8c4a2d1" }, "aSide": { "$ref": "#/components/schemas/ASide_657eaec5" }, "zSide": { "$ref": "#/components/schemas/ZSide_205c456e" }, "order": { "$ref": "#/components/schemas/Order_95704d9c" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_d2262128" }, "bmmrType": { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.\n", "example": "EQUINIX" } }, "description": "Request to order a single connection. The A-side is always a patch panel\n port in your own cage; the Z-side shape depends on\n connectionDestinationType." }, "description": "The two connections forming the diverse pair — one PRIMARY and one\n SECONDARY.\n" } } ], "result": { "name": "fabric_createBulkOpticalConnectResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_2f250477" } } }, "description": "Dual diverse pair Connection", "x-fastmcp-top-level-schema": "OpticalConnectBulk" } }, "x-mcp-annotations": { "title": "Create Dual Diverse Optical Metro Connect Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createCloudRouter", "summary": "Create Router", "description": "This API provides capability to create user's Cloud Router\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "required": true, "schema": { "enum": [ "XF_ROUTER" ], "type": "string" } }, { "name": "name", "description": "Customer-provided Cloud Router name", "required": true, "schema": { "type": "string", "description": "Customer-provided Cloud Router name" } }, { "name": "location", "required": true, "schema": { "$ref": "#/components/schemas/Location_32724e48" } }, { "name": "package", "description": "Fabric Cloud Router Package Type", "required": true, "schema": { "$ref": "#/components/schemas/Package" } }, { "name": "notifications", "description": "Preferences for notifications on connection configuration or status changes", "required": true, "schema": { "$ref": "#/components/schemas/Notifications_903ff2b6" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } }, { "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/Order_3e7328e1" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "account", "required": false, "schema": { "$ref": "#/components/schemas/Account_0dedb04b" } }, { "name": "marketplaceSubscription", "description": "Equinix Fabric Entity for Marketplace Subscription", "required": false, "schema": { "$ref": "#/components/schemas/MarketplaceSubscription" } } ], "result": { "name": "fabric_createCloudRouterResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCloudRouterResult_0cce220a" } }, "x-mcp-annotations": { "title": "Create Router", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createCloudRouterAction", "summary": "Create Route Table Action", "description": "This API provides capability to refresh route table and bgp session summary information\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "description": "Cloud router action type", "required": true, "schema": { "enum": [ "BGP_SESSION_STATUS_UPDATE", "ROUTE_TABLE_ENTRY_UPDATE", "RECEIVED_ROUTE_ENTRY_UPDATE", "ADVERTISED_ROUTE_ENTRY_UPDATE" ], "type": "string", "description": "Cloud router action type" } }, { "name": "connection", "description": "Connection object for router actions", "required": false, "schema": { "$ref": "#/components/schemas/Connection_aa288f10" } } ], "result": { "name": "fabric_createCloudRouterActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCloudRouterActionResult" } }, "x-mcp-annotations": { "title": "Create Route Table Action", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createCloudRouterCommand", "summary": "Create Command", "description": "This API provides capability to initiate Command\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "description": "Fabric Cloud Router Command Type", "required": true, "schema": { "enum": [ "PING_COMMAND", "TRACEROUTE_COMMAND" ], "type": "string", "description": "Fabric Cloud Router Command Type", "example": "PING_COMMAND" } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "request", "description": "Fabric Cloud Router Command Request", "required": true, "schema": { "required": [ "destination", "sourceConnection" ], "type": "object", "properties": { "destination": { "type": "string", "description": "Fabric Cloud Router Ping or Traceroute Command Destination", "example": "8.8.8.8" }, "sourceConnection": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, "description": "Connection object for Cloud Router Command" }, "timeout": { "type": "integer", "description": "Timeout in seconds for Fabric Cloud Router Command:\n - For `PING_COMMAND`: Packet timeout duration. The default value is 5.\n - For `TRACEROUTE_COMMAND`: Probe timeout duration.\n The default value is 2 and it is not configurable.\n", "example": 2 }, "dataBytes": { "maximum": 9000.0, "minimum": 16.0, "type": "integer", "description": "Ping Command DataBytes. \nThis field is only applicable for commands of type `PING_COMMAND`.\n", "default": 64, "example": 100 }, "probes": { "type": "integer", "description": "Number of probes for Fabric Cloud Router Traceroute Command.\nThis field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable.\n", "default": 3, "example": 3 }, "hopsMax": { "maximum": 30.0, "type": "integer", "description": "Maximum number of hops for the traceroute command.\nThis field is only applicable for commands of type `TRACEROUTE_COMMAND`.\n", "default": 20, "example": 20 } }, "description": "Fabric Cloud Router Command Request" } }, { "name": "name", "description": "Customer-provided Cloud Router Command name", "required": false, "schema": { "type": "string", "description": "Customer-provided Cloud Router Command name" } }, { "name": "description", "description": "Customer-provided Cloud Router Command description", "required": false, "schema": { "type": "string", "description": "Customer-provided Cloud Router Command description" } } ], "result": { "name": "fabric_createCloudRouterCommandResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCloudRouterCommandResult" } }, "x-mcp-annotations": { "title": "Create Command", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createCompanyProfile", "summary": "Create Company Profile", "description": "Create a new company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "required": true, "schema": { "type": "string", "example": "COMPANY_PROFILE" } }, { "name": "name", "required": true, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "example": "Equinix" } }, { "name": "summary", "required": true, "schema": { "maxLength": 125, "minLength": 1, "type": "string", "example": "Global interconnection and data center company" } }, { "name": "description", "required": true, "schema": { "maxLength": 450, "minLength": 1, "type": "string", "example": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers." } }, { "name": "webUrl", "required": true, "schema": { "type": "string", "example": "https://www.equinix.com" } }, { "name": "pointOfContacts", "required": false, "schema": { "$ref": "#/components/schemas/PointOfContacts" } }, { "name": "notifications", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_ebd7698b" } }, { "name": "overview", "required": false, "schema": { "type": "string", "example": "About Initech Corp

lorem ipsum

" } }, { "name": "contactUrl", "required": false, "schema": { "type": "string", "example": "https://www.equinix.com/contact-us" } } ], "result": { "name": "fabric_createCompanyProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCompanyProfileResult" } }, "x-mcp-annotations": { "title": "Create Company Profile", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createConnection", "summary": "Create Connection", "description": "This API provides capability to create user's virtual connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Connections" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Connection type", "required": true, "schema": { "enum": [ "EVPL_VC", "EPL_VC", "EC_VC", "IP_VC", "ACCESS_EPL_VC", "EIA_VC", "EVPLAN_VC", "EPLAN_VC", "EVPTREE_VC", "EPTREE_VC", "IPWAN_VC", "IA_VC", "MC_VC", "IX_VC", "GW_VC", "IPX_VC" ], "type": "string", "description": "Connection type" } }, { "name": "name", "description": "Customer-provided connection name", "required": true, "schema": { "type": "string", "description": "Customer-provided connection name" } }, { "name": "notifications", "description": "Preferences for notifications on connection configuration or status changes", "required": true, "schema": { "$ref": "#/components/schemas/Notifications_903ff2b6" } }, { "name": "bandwidth", "description": "Connection bandwidth in Mbps", "required": true, "schema": { "maximum": 100000.0, "minimum": 0.0, "type": "integer", "description": "Connection bandwidth in Mbps" } }, { "name": "aSide", "description": "Connection configuration object for each side of multi-segment connection", "required": true, "schema": { "$ref": "#/components/schemas/ASide_cdc3f780" } }, { "name": "zSide", "description": "Connection configuration object for each side of multi-segment connection", "required": true, "schema": { "$ref": "#/components/schemas/ASide_cdc3f780" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } }, { "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/Order_3e7328e1" } }, { "name": "geoScope", "description": "Geographic boundary for the connection", "required": false, "schema": { "enum": [ "CANADA", "CONUS", "JAPAN", "UK", "AUSTRALIA", "BRAZIL", "SWITZERLAND", "EU" ], "type": "string", "description": "Geographic boundary for the connection" } }, { "name": "redundancy", "description": "Connection redundancy configuration", "required": false, "schema": { "$ref": "#/components/schemas/Redundancy_03b2b702" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "additionalInfo", "description": "Connection additional information", "required": false, "schema": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Connection additional information" } }, { "name": "marketplaceSubscription", "description": "Equinix Fabric Entity for Marketplace Subscription", "required": false, "schema": { "$ref": "#/components/schemas/MarketplaceSubscription" } } ], "result": { "name": "fabric_createConnectionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionResult" } }, "x-mcp-annotations": { "title": "Create Connection", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createConnectionAction", "summary": "Create Connection Action", "description": "This API provides capability to accept/reject user's virtual connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Connections" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "description": "Connection action type", "required": true, "schema": { "$ref": "#/components/schemas/Type_fe0885cb" } }, { "name": "description", "description": "Connection rejection reason detail", "required": false, "schema": { "type": "string", "description": "Connection rejection reason detail" } }, { "name": "data", "description": "Connection acceptance data", "required": false, "schema": { "$ref": "#/components/schemas/Data_da9164b4" } } ], "result": { "name": "fabric_createConnectionActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "type", "href", "uuid", "data" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Type_fe0885cb" }, "href": { "type": "string", "description": "Connection action URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned connection identifier" }, "state": { "enum": [ "SUCCEEDED" ], "type": "string", "description": "Connection action response state" }, "description": { "type": "string", "description": "Connection rejection reason detail" }, "data": { "$ref": "#/components/schemas/Data_da9164b4" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Connection action", "x-fastmcp-top-level-schema": "ConnectionAction" } }, "x-mcp-annotations": { "title": "Create Connection Action", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createConnectionRoutingProtocol", "summary": "Create Routing Protocol", "description": "This API provides capability to create Routing Protocol for connections\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "description": "Routing protocol type", "required": true, "schema": { "enum": [ "BGP", "DIRECT" ], "type": "string", "description": "Routing protocol type" } } ], "result": { "name": "fabric_createConnectionRoutingProtocolResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_a1b7bd9c" } }, "x-mcp-annotations": { "title": "Create Routing Protocol", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createConnectionRoutingProtocolsInBulk", "summary": "Bulk Create Routing Protocols", "description": "This API provides capability to create Routing Protocol for connections\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "data", "description": "Connection routing protocol configuration", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_062179d0" }, "description": "Connection routing protocol configuration" } } ], "result": { "name": "fabric_createConnectionRoutingProtocolsInBulkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolsInBulkResult" } }, "x-mcp-annotations": { "title": "Bulk Create Routing Protocols", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createCrossConnect", "summary": "Create Cross Connect", "description": "The API provides capability to create a new Cross Connect.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Type of Cross Connect.", "required": true, "schema": { "enum": [ "XC" ], "type": "string", "description": "Type of Cross Connect.", "example": "XC" } }, { "name": "name", "description": "A short, descriptive name for this Cross Connect.", "required": true, "schema": { "maxLength": 50, "minLength": 3, "type": "string", "description": "A short, descriptive name for this Cross Connect.", "example": "My-CC-service" } }, { "name": "aSide", "description": "A-Side connection details.", "required": true, "schema": { "$ref": "#/components/schemas/ASide_e75667ae" } }, { "name": "zSide", "description": "Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested.\n", "required": true, "schema": { "$ref": "#/components/schemas/ZSide_94f5b33c" } }, { "name": "bmmrType", "description": "Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself.\n", "required": false, "schema": { "allOf": [ { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "Cross Connect BMMR Type.", "example": "EQUINIX" } ], "description": "Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself.\n" } }, { "name": "circuitId", "description": "Circuit identifier of the Cross Connect.", "required": false, "schema": { "type": "string", "description": "Circuit identifier of the Cross Connect." } }, { "name": "redundancy", "description": "Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY.\n", "required": false, "schema": { "$ref": "#/components/schemas/Redundancy_609c857f" } }, { "name": "schedule", "description": "Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code.\n", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_118f5655" } }, { "name": "services", "description": "Cross Connect Services.", "required": false, "schema": { "$ref": "#/components/schemas/Services_1cb13837" } }, { "name": "notifications", "description": "Preferences for notifications on Cross Connect configuration or status changes.\n", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_7cbe42a5" } }, { "name": "order", "description": "Cross Connect Order.", "required": false, "schema": { "$ref": "#/components/schemas/Order_41b238f5" } }, { "name": "notes", "description": "Additional Note.", "required": false, "schema": { "maxItems": 1, "type": "array", "items": { "required": [ "comments" ], "type": "object", "properties": { "comments": { "maxLength": 4000, "type": "string", "description": "Note comments.", "example": "test note" } }, "description": "Cross Connect Note." }, "description": "Additional Note." } }, { "name": "attachments", "description": "Additional Attachments.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_520ac97b" } } ], "result": { "name": "fabric_createCrossConnectResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCrossConnectResult" } }, "x-mcp-annotations": { "title": "Create Cross Connect", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createDiverseCrossConnect", "summary": "Create Diverse Cross Connect", "description": "The API provides capability to create several Cross Connects in a single order - a diverse pair where the PRIMARY and the SECONDARY Cross Connect are placed at the same time, or multiple Cross Connects by sending one entry per Cross Connect.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "data", "description": "For a diverse pair, send two entries - one with redundancy.priority PRIMARY and one with SECONDARY - and omit redundancy.group, which Equinix assigns.\n", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "title": "CreateCrossConnect", "required": [ "type", "name", "aSide", "zSide" ], "type": "object", "properties": { "type": { "enum": [ "XC" ], "type": "string", "description": "Type of Cross Connect.", "example": "XC" }, "name": { "maxLength": 50, "minLength": 3, "type": "string", "description": "A short, descriptive name for this Cross Connect.", "example": "My-CC-service" }, "bmmrType": { "allOf": [ { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "Cross Connect BMMR Type.", "example": "EQUINIX" } ], "description": "Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself.\n" }, "circuitId": { "type": "string", "description": "Circuit identifier of the Cross Connect." }, "redundancy": { "$ref": "#/components/schemas/Redundancy_609c857f" }, "aSide": { "$ref": "#/components/schemas/ASide_e75667ae" }, "zSide": { "$ref": "#/components/schemas/ZSide_94f5b33c" }, "schedule": { "$ref": "#/components/schemas/Schedule_118f5655" }, "services": { "$ref": "#/components/schemas/Services_1cb13837" }, "notifications": { "$ref": "#/components/schemas/Notifications_7cbe42a5" }, "order": { "$ref": "#/components/schemas/Order_41b238f5" }, "notes": { "maxItems": 1, "type": "array", "items": { "required": [ "comments" ], "type": "object", "properties": { "comments": { "maxLength": 4000, "type": "string", "description": "Note comments.", "example": "test note" } }, "description": "Cross Connect Note." }, "description": "Additional Note." }, "attachments": { "$ref": "#/components/schemas/Attachments_520ac97b" } }, "description": "Create Cross Connect request. A single request body supports all Cross Connect connection types - patch panel to patch panel, connection with LOA and connection to a BMMR (by Equinix or by Self). Refer to the request examples for each use case.\n" }, "description": "For a diverse pair, send two entries - one with redundancy.priority PRIMARY and one with SECONDARY - and omit redundancy.group, which Equinix assigns.\n" } } ], "result": { "name": "fabric_createDiverseCrossConnectResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "CrossConnectDiverse", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_1eef7681" }, "description": "The Cross Connects the diverse order applies to." } }, "description": "Cross Connects returned by a diverse order. One item is returned per Cross Connect requested; a diverse pair returns the PRIMARY and the SECONDARY Cross Connect sharing one redundancy group.\n", "x-fastmcp-top-level-schema": "CrossConnectDiverse" } }, "x-mcp-annotations": { "title": "Create Diverse Cross Connect", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createEiaService", "summary": "Create Internet Access Service", "description": "Creates Internet Access Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Access Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Type of the service, either single or dual internet access", "required": true, "schema": { "enum": [ "SINGLE_IA", "DUAL_IA" ], "type": "string", "description": "Type of the service, either single or dual internet access", "x-enum-varnames": [ "SINGLE_IA", "DUAL_IA" ] } }, { "name": "name", "description": "The name of the EIA Service", "required": true, "schema": { "type": "string", "description": "The name of the EIA Service" } }, { "name": "routingProtocol", "required": true, "schema": { "required": [ "type", "customerRoutes" ], "type": "object", "properties": { "type": { "enum": [ "BGP", "DIRECT", "STATIC" ], "type": "string", "x-enum-varnames": [ "BGP", "DIRECT", "STATIC" ] }, "customerRoutes": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "required": [ "ipBlock" ], "type": "object", "properties": { "ipBlock": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier for the IP Block", "format": "uuid" } } } } } } } } }, { "name": "billing", "required": true, "schema": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "x-enum-varnames": [ "FIXED", "USAGE_BASED", "BURST_BASED" ] } } } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "account", "required": true, "schema": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account number" }, "href": { "type": "string", "description": "Account URL path", "format": "uri", "example": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234" } } } }, { "name": "bandwidth", "description": "Bandwidth of the service", "required": false, "schema": { "type": "integer", "description": "Bandwidth of the service" } }, { "name": "bandwidthCommit", "description": "Minimum bandwidth commit for burst billing variant of the service", "required": false, "schema": { "type": "integer", "description": "Minimum bandwidth commit for burst billing variant of the service" } }, { "name": "order", "required": false, "schema": { "type": "object", "properties": { "purchaseOrderNumber": { "type": [ "string", "null" ], "description": "Purchase order number" }, "orderNumber": { "type": [ "string", "null" ], "description": "Order Number" }, "orderLine": { "type": [ "string", "null" ], "description": "Order Line Number" } } } } ], "result": { "name": "fabric_createEiaServiceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createEiaServiceResult" } }, "x-mcp-annotations": { "title": "Create Internet Access Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createExchangeService", "summary": "Create Internet Exchange Service", "description": "This API provides capability to create Internet Exchange Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Exchange Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Internet Exchange Service type", "required": true, "schema": { "enum": [ "IX" ], "type": "string", "description": "Internet Exchange Service type", "example": "IX" } }, { "name": "name", "description": "Customer-provided internet exchange service name", "required": true, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Customer-provided internet exchange service name", "example": "ix_exchange_service" } }, { "name": "publicPeeringConnection", "description": "Public Peering Connection", "required": true, "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "connection id", "format": "uuid", "example": "b44c6e6c-2c36-4488-b3f1-47064357b5b4" } }, "description": "Public Peering Connection" } }, { "name": "routingProtocol", "required": true, "schema": { "type": "object", "properties": { "customerAsn": { "type": "integer", "description": "Customer Autonomous System Number (ASN)", "example": 1100 }, "macAddress": { "type": "string", "description": "MAC address of the customer interface", "example": "00:11:22:33:44:55" }, "bgpIpv4": { "$ref": "#/components/schemas/BgpIpv4_c81b618c" }, "bgpIpv6": { "$ref": "#/components/schemas/BgpIpv4_c81b618c" } } } }, { "name": "description", "description": "Customer-provided internet exchange service description", "required": false, "schema": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Customer-provided internet exchange service description", "example": "ix_exchange_service" } }, { "name": "order", "description": "Ordering and billing reference details for this Exchange Service.", "required": false, "schema": { "$ref": "#/components/schemas/Order_42dc2ad5" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "account", "required": false, "schema": { "$ref": "#/components/schemas/Account_0dedb04b" } }, { "name": "notifications", "description": "Preferences for notifications on Internet Exchange Service configuration or status changes", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_a0ca161e" } } ], "result": { "name": "fabric_createExchangeServiceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createExchangeServiceResult" } }, "x-mcp-annotations": { "title": "Create Internet Exchange Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createExchangeServiceAction", "summary": "Create Internet Exchange Service Action", "description": "This API provides capability to perform actions on Internet Exchange Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Exchange Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "exchangeServiceId", "description": "Internet Exchange Service UUID", "required": true, "schema": { "type": "string", "description": "Internet Exchange Service UUID", "format": "uuid", "example": "a8ba52de-faae-43b5-b0b1-6904d37ee011" } }, { "name": "type", "required": true, "schema": { "enum": [ "EXCHANGE_SERVICE_ACTIVATE", "EXCHANGE_SERVICE_VALIDATE", "EXCHANGE_SERVICE_RETRY_PROVISION" ], "type": "string" } } ], "result": { "name": "fabric_createExchangeServiceActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "allOf": [ { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "EXCHANGE_SERVICE_ACTIVATE", "EXCHANGE_SERVICE_VALIDATE", "EXCHANGE_SERVICE_RETRY_PROVISION" ], "type": "string" } }, "description": "Internet Exchange Service Action Request" }, { "type": "object", "properties": { "href": { "type": "string", "description": "Internet Exchange Service Action URI", "example": "https://api.equinix.com/fabric/v4/exchangeService/e8ba52fe-faae-43b5-b0b1-6904d37ee011/actions/a8ba52de-faae-43b5-b0b1-6904d37ee011" }, "uuid": { "type": "string", "description": "Action identifier", "format": "uuid", "example": "a8ba52de-faae-43b5-b0b1-6904d37ee011" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Action description", "example": "Action description text" }, "state": { "enum": [ "PENDING", "SUCCEEDED", "FAILED" ], "type": "string", "description": "State", "example": "PENDING" }, "changelog": { "$ref": "#/components/schemas/Changelog" } } } ], "x-fastmcp-top-level-schema": "ExchangeServiceActionResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Create Internet Exchange Service Action", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createLoa", "summary": "Create Loa", "description": "The API provides capability to create a new Loa\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "body", "description": "Create Loa", "required": true, "schema": { "description": "Create Loa", "anyOf": [ { "title": "IssueLoa", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Body_034a87c0" }, { "required": [ "type", "demarcationPoint" ], "type": "object", "properties": { "expirationDateTime": { "type": "string", "description": "Date and time when this LOA expires.
Default to 3 months from the creation date\n", "format": "date-time", "example": "2026-11-06T07:00:00Z" }, "requestor": { "$ref": "#/components/schemas/Requestor" }, "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_27ae5d2c" } } } ], "description": "Issue Loa" }, { "title": "RequestLoa", "allOf": [ { "$ref": "#/components/schemas/Body_034a87c0" }, { "required": [ "type", "location" ], "type": "object", "properties": { "issuer": { "$ref": "#/components/schemas/Issuer" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code", "example": "AM1" } }, "description": "Eligible location where LOA can be issued." } } } ], "description": "Request Loa" } ] } } ], "result": { "name": "fabric_createLoaResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createLoaResult" } }, "x-mcp-annotations": { "title": "Create Loa", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createLoaNoteByLoaId", "summary": "Create Loa Note", "description": "The API provides capability to create Loa note by Loa ID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } }, { "name": "comments", "description": "The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA.\n", "required": true, "schema": { "maxLength": 4000, "minLength": 0, "type": "string", "description": "The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA.\n", "example": "LOA under review by our team. Expected response within 2 business days" } } ], "result": { "name": "fabric_createLoaNoteByLoaIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "type": { "enum": [ "ISSUER", "REQUESTOR" ], "type": "string", "description": "Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization.\n", "example": "ISSUER" }, "href": { "type": "string", "description": "URI to note resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/loas/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306/notes/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Unique identifier of this note.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "comments": { "type": "string", "description": "Content of the note as submitted by the user.", "example": "LOA under review by our team. Expected response within 2 business days" }, "createdDateTime": { "type": "string", "description": "Date and time when the note was created.", "format": "date-time", "example": "2023-08-01T12:34:56Z" } }, "description": "Represents a note added to a LOA by an authorized user from either the issuer or requestor organization\n", "x-fastmcp-top-level-schema": "LoaNoteDetails" } }, "x-mcp-annotations": { "title": "Create Loa Note", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createLogo", "summary": "Create Logo", "description": "Create Logo for Equinix Fabric™ Company Profile\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Logos" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "logo", "description": "Logo image file", "required": true, "schema": { "type": "string", "description": "Logo image file", "format": "binary" } }, { "name": "name", "description": "Name of the Logo", "required": true, "schema": { "maxLength": 24, "minLength": 1, "type": "string", "description": "Name of the Logo", "example": "Equinix Logo" } }, { "name": "description", "description": "Description of the logo", "required": true, "schema": { "maxLength": 125, "minLength": 1, "type": "string", "description": "Description of the logo", "example": "Company branding logo" } }, { "name": "type", "description": "Type of logo", "required": true, "schema": { "type": "string", "description": "Type of logo", "example": "COMPANY_LOGO" } } ], "result": { "name": "fabric_createLogoResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createLogoResult" } }, "x-mcp-annotations": { "title": "Create Logo", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createNetwork", "summary": "Create Network", "description": "This API provides capability to create user's Fabric Network\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Network type", "required": true, "schema": { "enum": [ "EVPLAN", "EPLAN", "IPWAN", "EVPTREE", "EPTREE" ], "type": "string", "description": "Network type" } }, { "name": "name", "description": "Customer-provided network name", "required": true, "schema": { "type": "string", "description": "Customer-provided network name" } }, { "name": "scope", "description": "Network scope", "required": true, "schema": { "enum": [ "REGIONAL", "GLOBAL", "LOCAL" ], "type": "string", "description": "Network scope" } }, { "name": "notifications", "description": "Preferences for notifications on network configuration or status changes", "required": true, "schema": { "$ref": "#/components/schemas/Notifications_4779732b" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } }, { "name": "location", "required": false, "schema": { "$ref": "#/components/schemas/Location_53f78db6" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } } ], "result": { "name": "fabric_createNetworkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createNetworkResult_32127b47" } }, "x-mcp-annotations": { "title": "Create Network", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createOpticalConnect", "summary": "Create Optical Metro Connect Service", "description": "Create a single Optical Metro Connect circuit.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Optical Metro Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "OC - Optical Connect Type", "required": true, "schema": { "enum": [ "OC" ], "type": "string", "description": "OC - Optical Connect Type", "example": "OC" } }, { "name": "bandwidth", "description": "Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.
\n", "required": true, "schema": { "type": "integer", "description": "Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.
\n", "example": 100000 } }, { "name": "connectionDestinationType", "description": "Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side.\n", "required": true, "schema": { "$ref": "#/components/schemas/ConnectionDestinationType" } }, { "name": "pathType", "description": "Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.\n", "required": true, "schema": { "$ref": "#/components/schemas/PathType_63f97b0d" } }, { "name": "aSide", "description": "A-Side configuration. Always a patch panel port from your cage.\n", "required": true, "schema": { "$ref": "#/components/schemas/ASide_657eaec5" } }, { "name": "zSide", "description": "Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization.\n", "required": true, "schema": { "$ref": "#/components/schemas/ZSide_205c456e" } }, { "name": "redundancy", "description": "Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.\n", "required": false, "schema": { "$ref": "#/components/schemas/Redundancy_e8c4a2d1" } }, { "name": "order", "description": "Ordering and billing reference details for this connection.", "required": false, "schema": { "$ref": "#/components/schemas/Order_95704d9c" } }, { "name": "account", "required": false, "schema": { "$ref": "#/components/schemas/Account_0dedb04b" } }, { "name": "notifications", "description": "Contacts to notify about connection configuration and status changes", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_d2262128" } }, { "name": "bmmrType", "description": "BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.\n", "required": false, "schema": { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.\n", "example": "EQUINIX" } } ], "result": { "name": "fabric_createOpticalConnectResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createOpticalConnectResult" } }, "x-mcp-annotations": { "title": "Create Optical Metro Connect Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createPort", "summary": "Create Port", "description": "Creates Equinix Fabric™ Port\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Type of Port", "required": true, "schema": { "enum": [ "XF_PORT" ], "type": "string", "description": "Type of Port" } }, { "name": "physicalPortsSpeed", "description": "Physical Ports Speed in Mbps", "required": true, "schema": { "minimum": 0.0, "type": "integer", "description": "Physical Ports Speed in Mbps" } }, { "name": "physicalPortsType", "description": "Physical Ports Type. 10GBASE_SMF is only applicable for IX ports", "required": true, "schema": { "enum": [ "1000BASE_LX", "10GBASE_LR", "100GBASE_LR4", "10GBASE_ER", "1000BASE_SX", "10GBASE_SMF", "400GBASE_LR4" ], "type": "string", "description": "Physical Ports Type. 10GBASE_SMF is only applicable for IX ports" } }, { "name": "connectivitySourceType", "description": "Port connectivity type", "required": true, "schema": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Port connectivity type" } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "account", "required": true, "schema": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account number", "format": "int64" } } } }, { "name": "location", "required": true, "schema": { "required": [ "metroCode" ], "type": "object", "properties": { "metroCode": { "type": "string", "example": "AM" } } } }, { "name": "encapsulation", "description": "Port encapsulation configuration", "required": true, "schema": { "type": "object", "properties": { "type": { "enum": [ "DOT1Q", "QINQ", "UNTAGGED" ], "type": "string", "description": "Port encapsulation protocol type" }, "tagProtocolId": { "type": "string", "description": "Port encapsulation tag protocol identifier" } }, "description": "Port encapsulation configuration" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } }, { "name": "physicalPortsCount", "required": false, "schema": { "type": "integer" } }, { "name": "bmmrType", "description": "BMMR Type is mandatory when connectivitySourceType is BMMR", "required": false, "schema": { "enum": [ "SELF", "EQUINIX" ], "type": "string", "description": "BMMR Type is mandatory when connectivitySourceType is BMMR" } }, { "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/Order_9b002780" } }, { "name": "serviceType", "description": "Port service Type", "required": false, "schema": { "enum": [ "EPL", "MSP" ], "type": "string", "description": "Port service Type" } }, { "name": "serviceCode", "description": "Identifies the service type associated with this port", "required": false, "schema": { "enum": [ "CX", "IX", "IA", "MC" ], "type": "string", "description": "Identifies the service type associated with this port" } }, { "name": "bandwidth", "description": "Equinix assigned response attribute for Port bandwidth in Mbps", "required": false, "schema": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port bandwidth in Mbps" } }, { "name": "demarcationPointIbx", "description": "A-side/Equinix ibx", "required": false, "schema": { "type": "string", "description": "A-side/Equinix ibx" } }, { "name": "tetherIbx", "description": "z-side/Equinix ibx", "required": false, "schema": { "type": "string", "description": "z-side/Equinix ibx" } }, { "name": "demarcationPoint", "description": "Customer physical Port", "required": false, "schema": { "$ref": "#/components/schemas/DemarcationPoint_970747e9" } }, { "name": "redundancy", "description": "Port redundancy configuration", "required": false, "schema": { "$ref": "#/components/schemas/Redundancy_616e679f" } }, { "name": "lagEnabled", "description": "Indicates whether Link Aggregation Group (LAG) is enabled on this port", "required": false, "schema": { "type": "boolean", "description": "Indicates whether Link Aggregation Group (LAG) is enabled on this port" } }, { "name": "package", "description": "Package settings for port", "required": false, "schema": { "type": "object", "properties": { "code": { "enum": [ "STANDARD", "UNLIMITED", "UNLIMITED_PLUS" ], "type": "string", "description": "Type of Port Package" } }, "description": "Package settings for port" } }, { "name": "notifications", "description": "Notification preferences", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_ccb07798" } }, { "name": "physicalPorts", "description": "Physical ports that implement this port", "required": false, "schema": { "$ref": "#/components/schemas/PhysicalPorts" } }, { "name": "loas", "description": "Port Loas", "required": false, "schema": { "type": "array", "items": { "properties": { "uuid": { "type": "string", "description": "uuid" }, "type": { "type": "string", "description": "Loa type", "example": "DIGITAL_LOA" } }, "description": "Port Loas" }, "description": "Port Loas" } } ], "result": { "name": "fabric_createPortResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createPortResult" } }, "x-mcp-annotations": { "title": "Create Port", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createRouteAggregation", "summary": "Create Route Aggregation", "description": "This API provides capability to create a Route Aggregation\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Route Aggregation type", "required": true, "schema": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION", "BGP_IPv6_PREFIX_AGGREGATION" ], "type": "string", "description": "Route Aggregation type" } }, { "name": "name", "required": true, "schema": { "type": "string", "example": "My-direct-route-1" } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "description", "description": "Customer-provided connection description", "required": false, "schema": { "type": "string", "description": "Customer-provided connection description" } } ], "result": { "name": "fabric_createRouteAggregationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationResult" } }, "x-mcp-annotations": { "title": "Create Route Aggregation", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createRouteAggregationRule", "summary": "Create Route Aggregation Rule", "description": "This API provides capability to create a Route Aggregation Rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "prefix", "required": true, "schema": { "type": "string", "example": "192.168.0.0/24" } }, { "name": "name", "required": false, "schema": { "type": "string", "example": "Private-subnet-Aggregation" } }, { "name": "description", "description": "Customer-provided Route Aggregation Rule description", "required": false, "schema": { "type": "string", "description": "Customer-provided Route Aggregation Rule description" } } ], "result": { "name": "fabric_createRouteAggregationRuleResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationRuleResult" } }, "x-mcp-annotations": { "title": "Create Route Aggregation Rule", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createRouteAggregationRulesInBulk", "summary": "Bulk Create Route Aggregation Rules", "description": "This API provides capability to create bulk route aggregation rules\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "data", "description": "Route Aggregation Rule configuration", "required": false, "schema": { "type": "array", "items": { "required": [ "prefix" ], "type": "object", "properties": { "name": { "type": "string", "example": "Private-subnet-Aggregation" }, "description": { "type": "string", "description": "Customer-provided Route Aggregation Rule description" }, "prefix": { "type": "string", "example": "192.168.0.0/24" } } }, "description": "Route Aggregation Rule configuration" } } ], "result": { "name": "fabric_createRouteAggregationRulesInBulkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationRulesInBulkResult" } }, "x-mcp-annotations": { "title": "Bulk Create Route Aggregation Rules", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createRouteFilter", "summary": "Create Route Filter", "description": "This API provides capability to create a Route Filter\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Route Filter type", "required": true, "schema": { "enum": [ "BGP_IPv4_PREFIX_FILTER", "BGP_IPv6_PREFIX_FILTER" ], "type": "string", "description": "Route Filter type" } }, { "name": "name", "required": true, "schema": { "type": "string", "example": "My-direct-route-1" } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "description", "description": "Customer-provided connection description", "required": false, "schema": { "type": "string", "description": "Customer-provided connection description" } } ], "result": { "name": "fabric_createRouteFilterResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterResult" } }, "x-mcp-annotations": { "title": "Create Route Filter", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createRouteFilterRule", "summary": "Create Route Filter Rule", "description": "This API provides capability to create a Route Filter Rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "prefix", "required": true, "schema": { "type": "string", "example": "192.168.0.0/24" } }, { "name": "name", "required": false, "schema": { "type": "string", "example": "Private-subnet-filter" } }, { "name": "description", "description": "Customer-provided Route Filter Rule description", "required": false, "schema": { "type": "string", "description": "Customer-provided Route Filter Rule description" } }, { "name": "prefixMatch", "required": false, "schema": { "type": "string", "default": "orlonger", "example": "orlonger, exact" } } ], "result": { "name": "fabric_createRouteFilterRuleResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterRuleResult" } }, "x-mcp-annotations": { "title": "Create Route Filter Rule", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createRouteFilterRulesInBulk", "summary": "Bulk Create Route Filter Rules", "description": "This API provides capability to create bulk route filter rules\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "data", "description": "Route Filter Rule configuration", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_ba551b86" }, "description": "Route Filter Rule configuration" } } ], "result": { "name": "fabric_createRouteFilterRulesInBulkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterRulesInBulkResult" } }, "x-mcp-annotations": { "title": "Bulk Create Route Filter Rules", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createServiceProfile", "summary": "Create Service Profile", "description": "Create Service Profile creates Equinix Fabric™ Service Profile\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Service profile type", "required": true, "schema": { "enum": [ "L2_PROFILE", "L3_PROFILE", "IA_PROFILE", "IX_PROFILE", "IC_PROFILE", "LMAAS_PROFILE" ], "type": "string", "description": "Service profile type", "example": "L2_PROFILE", "x-eqx-api-linter-skip-rules": [ 40 ] } }, { "name": "name", "description": "Customer-assigned service profile name", "required": true, "schema": { "maxLength": 50, "type": "string", "description": "Customer-assigned service profile name", "example": "Sample Service Profile" } }, { "name": "description", "description": "User-provided service description should be of maximum length 375", "required": true, "schema": { "type": "string", "description": "User-provided service description should be of maximum length 375", "example": "offering connectivity to my-network" } }, { "name": "href", "description": "Service Profile URI response attribute", "required": false, "schema": { "type": "string", "description": "Service Profile URI response attribute", "format": "uri" } }, { "name": "uuid", "description": "Equinix-assigned service profile identifier", "required": false, "schema": { "type": "string", "description": "Equinix-assigned service profile identifier", "format": "uuid" } }, { "name": "notifications", "description": "Recipients of notifications on service profile change", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_f30d1188" } }, { "name": "tags", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "visibility", "required": false, "schema": { "enum": [ "PRIVATE", "PUBLIC" ], "type": "string" } }, { "name": "allowedEmails", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "email" } } }, { "name": "accessPointTypeConfigs", "required": false, "schema": { "$ref": "#/components/schemas/AccessPointTypeConfigs" } }, { "name": "customFields", "required": false, "schema": { "$ref": "#/components/schemas/CustomFields" } }, { "name": "marketingInfo", "required": false, "schema": { "$ref": "#/components/schemas/MarketingInfo" } }, { "name": "ports", "required": false, "schema": { "$ref": "#/components/schemas/Ports" } }, { "name": "virtualDevices", "required": false, "schema": { "$ref": "#/components/schemas/VirtualDevices" } }, { "name": "metros", "description": "Derived response attribute.", "required": false, "schema": { "$ref": "#/components/schemas/Metros" } }, { "name": "environments", "description": "Provider environments associated with this IC_PROFILE service profile. Beta", "required": false, "schema": { "$ref": "#/components/schemas/Environments" } }, { "name": "selfProfile", "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker.", "required": false, "schema": { "type": "boolean", "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker." } }, { "name": "projectId", "required": false, "schema": { "type": "string" } }, { "name": "lastMileConfig", "description": "Last-mile provider catalogs and offerings available for this service profile.", "required": false, "schema": { "$ref": "#/components/schemas/LastMileConfig" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } } ], "result": { "name": "fabric_createServiceProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceProfileResult" } }, "x-mcp-annotations": { "title": "Create Service Profile", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createServiceProfileAction", "summary": "Create Service Profile Action", "description": "This API provides capability to accept/reject service profile update requests\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } }, { "name": "type", "description": "Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION", "required": true, "schema": { "type": "string", "description": "Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION", "example": "PROFILE_UPDATE_ACCEPTANCE" } }, { "name": "description", "description": "Action description", "required": false, "schema": { "type": "string", "description": "Action description", "example": "Approved to migrate to public" } } ], "result": { "name": "fabric_createServiceProfileActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "href": { "type": "string", "description": "Service Profile Action URI", "format": "uri" }, "type": { "type": "string", "description": "Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION", "example": "PROFILE_UPDATE_ACCEPTANCE" }, "uuid": { "type": "string", "description": "Equinix-assigned action identifier", "format": "uuid" }, "comments": { "type": "string", "description": "Action comments", "example": "Approved to migrate to public" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Service Profile Action Response", "x-fastmcp-top-level-schema": "ServiceProfileActionResponse" } }, "x-mcp-annotations": { "title": "Create Service Profile Action", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createServiceToken", "summary": "Create Service Token", "description": "Create Service Tokens generates Equinix Fabric™ service tokens. These tokens authorize users to access protected resources and services.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Tokens" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } }, { "name": "type", "description": "Type of Service Token", "required": false, "schema": { "enum": [ "VC_TOKEN", "EPL_TOKEN" ], "type": "string", "description": "Type of Service Token" } }, { "name": "href", "description": "An absolute URL that is the subject of the link's context.", "required": false, "schema": { "type": "string", "description": "An absolute URL that is the subject of the link's context.", "format": "uri" } }, { "name": "expiry", "required": false, "schema": { "type": "integer" } }, { "name": "uuid", "description": "Equinix-assigned service token identifier", "required": false, "schema": { "type": "string", "description": "Equinix-assigned service token identifier", "format": "uuid" } }, { "name": "issuerSide", "description": "information about token side", "required": false, "schema": { "type": "string", "description": "information about token side" } }, { "name": "name", "description": "Customer-provided service token name", "required": false, "schema": { "type": "string", "description": "Customer-provided service token name" } }, { "name": "description", "description": "Customer-provided service token description", "required": false, "schema": { "type": "string", "description": "Customer-provided service token description" } }, { "name": "expirationDateTime", "description": "Expiration date and time of the service token.", "required": false, "schema": { "type": "string", "description": "Expiration date and time of the service token.", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, { "name": "connection", "description": "Service Token Connection Type Information", "required": false, "schema": { "$ref": "#/components/schemas/Connection_dd127cea" } }, { "name": "state", "description": "Service token state", "required": false, "schema": { "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "DELETED" ], "type": "string", "description": "Service token state" } }, { "name": "notifications", "description": "Service token related notifications", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_9750afd0" } }, { "name": "account", "description": "AM-CRH customers can provide Account number", "required": false, "schema": { "$ref": "#/components/schemas/Account_8518334f" } }, { "name": "changelog", "description": "Change log", "required": false, "schema": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, { "name": "project", "description": "Project is optional for AM-CRH customers. If not provided, a default project will be assigned.", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } }, "description": "Project is optional for AM-CRH customers. If not provided, a default project will be assigned." } } ], "result": { "name": "fabric_createServiceTokenResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceTokenResult" } }, "x-mcp-annotations": { "title": "Create Service Token", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createServiceTokenAction", "summary": "Create Service Token Action", "description": "This API provides capability to accept/reject user's servicetokens\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Tokens" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceTokenId", "description": "Service Token UUID", "required": true, "schema": { "type": "string", "description": "Service Token UUID", "format": "uuid" } }, { "name": "type", "description": "Service Token action type", "required": true, "schema": { "enum": [ "RESEND_EMAIL_NOTIFICATION" ], "type": "string", "description": "Service Token action type" } } ], "result": { "name": "fabric_createServiceTokenActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceTokenResult" } }, "x-mcp-annotations": { "title": "Create Service Token Action", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createStreamAlertRules", "summary": "Create Stream Alert Rule", "description": "This API provides capability to create user's Stream Alert Rules\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Alert Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "type", "required": true, "schema": { "enum": [ "METRIC_ALERT" ], "type": "string" } }, { "name": "name", "description": "Customer-provided stream name", "required": true, "schema": { "type": "string", "description": "Customer-provided stream name" } }, { "name": "metricSelector", "required": true, "schema": { "required": [ "include" ], "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "example": "equinix.fabric.metro.sv_da.latency" }, "description": "Stream alert rule filtered by metric name" } } } }, { "name": "resourceSelector", "required": true, "schema": { "$ref": "#/components/schemas/ResourceSelector_b024e7f3" } }, { "name": "detectionMethod", "required": true, "schema": { "$ref": "#/components/schemas/DetectionMethod_5a5caddf" } }, { "name": "description", "description": "Customer-provided stream description", "required": false, "schema": { "type": "string", "description": "Customer-provided stream description" } }, { "name": "enabled", "description": "Stream alert rule enabled status", "required": false, "schema": { "type": "boolean", "description": "Stream alert rule enabled status", "default": true, "example": true } } ], "result": { "name": "fabric_createStreamAlertRulesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamAlertRulesResult" } }, "x-mcp-annotations": { "title": "Create Stream Alert Rule", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createStreamSubscriptions", "summary": "Create Subscription", "description": "This API provides capability to create user's Stream Subscriptions\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "type", "required": true, "schema": { "enum": [ "STREAM_SUBSCRIPTION" ], "type": "string" } }, { "name": "name", "description": "Customer-provided stream subscription name", "required": true, "schema": { "type": "string", "description": "Customer-provided stream subscription name" } }, { "name": "sink", "description": "Create Stream destination", "required": true, "schema": { "$ref": "#/components/schemas/Sink_80fea9cf" } }, { "name": "description", "description": "Customer-provided stream subscription description", "required": false, "schema": { "type": "string", "description": "Customer-provided stream subscription description" } }, { "name": "enabled", "description": "Stream subscription enabled status", "required": false, "schema": { "type": "boolean", "description": "Stream subscription enabled status", "default": true, "example": true } }, { "name": "metricSelector", "required": false, "schema": { "$ref": "#/components/schemas/MetricSelector" } }, { "name": "eventSelector", "required": false, "schema": { "$ref": "#/components/schemas/MetricSelector" } } ], "result": { "name": "fabric_createStreamSubscriptionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamSubscriptionsResult" } }, "x-mcp-annotations": { "title": "Create Subscription", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createStreams", "summary": "Create Stream", "description": "This API provides capability to create user's stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "required": true, "schema": { "enum": [ "TELEMETRY_STREAM" ], "type": "string" } }, { "name": "name", "description": "Customer-provided stream name", "required": true, "schema": { "type": "string", "description": "Customer-provided stream name" } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "description", "description": "Customer-provided stream description", "required": false, "schema": { "type": "string", "description": "Customer-provided stream description" } }, { "name": "account", "required": false, "schema": { "$ref": "#/components/schemas/Account_0dedb04b" } }, { "name": "notifications", "description": "Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only.", "required": false, "schema": { "maxItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_49b424e4" }, "description": "Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only." } } ], "result": { "name": "fabric_createStreamsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamsResult" } }, "x-mcp-annotations": { "title": "Create Stream", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createTag", "summary": "Create Tag", "description": "Create Tag for Equinix Fabric™\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Tags" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Type of tag", "required": true, "schema": { "type": "string", "description": "Type of tag", "example": "PREDEFINED_TAG" } }, { "name": "displayName", "description": "Display name of the Tag", "required": true, "schema": { "maxLength": 24, "minLength": 1, "type": "string", "description": "Display name of the Tag", "example": "LLM" } }, { "name": "notifications", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_ebd7698b" } } ], "result": { "name": "fabric_createTagResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createTagResult" } }, "x-mcp-annotations": { "title": "Create Tag", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_createTimeServices", "summary": "Create Time Service", "description": "The API provides capability to create Precision Time service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Precision Time Service Type refers to the corresponding Protocol.", "required": true, "schema": { "enum": [ "NTP", "PTP" ], "type": "string", "description": "Precision Time Service Type refers to the corresponding Protocol." } }, { "name": "name", "description": "Precision Time Service name.", "required": true, "schema": { "type": "string", "description": "Precision Time Service name." } }, { "name": "package", "description": "Precision Time Service Level Request", "required": true, "schema": { "$ref": "#/components/schemas/PrecisionTimePackageRequest" } }, { "name": "connections", "required": true, "schema": { "$ref": "#/components/schemas/Connections_d0aafdac" } }, { "name": "ipv4", "description": "EPT service network information", "required": true, "schema": { "$ref": "#/components/schemas/Ipv4_b8d452c8" } }, { "name": "ntpAdvancedConfiguration", "description": "NTP Advanced configuration - MD5 Authentication.", "required": false, "schema": { "$ref": "#/components/schemas/NtpAdvancedConfiguration" } }, { "name": "ptpAdvancedConfiguration", "description": "PTP Advanced Configuration.", "required": false, "schema": { "$ref": "#/components/schemas/PtpAdvancedConfiguration" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "order", "description": "Precision Time Order", "required": false, "schema": { "$ref": "#/components/schemas/PrecisionTimeOrder" } } ], "result": { "name": "fabric_createTimeServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PrecisionTimeServiceResponse" } }, "x-mcp-annotations": { "title": "Create Time Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_deleteAppDomainByUuid", "summary": "Delete Domain", "description": "This API provides capability to delete user's Domain\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Domains" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appDomainId", "description": "App Domain UUID", "required": true, "schema": { "type": "string", "description": "App Domain UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } } ], "result": { "name": "fabric_deleteAppDomainByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppDomainResult" } }, "x-mcp-annotations": { "title": "Delete Domain", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteAppLinkByUuid", "summary": "Delete Link", "description": "This API provides capability to delete user's Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } } ], "result": { "name": "fabric_deleteAppLinkByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppLinkResult" } }, "x-mcp-annotations": { "title": "Delete Link", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteAppServiceByUuid", "summary": "Delete Service", "description": "This API provides capability to delete user's Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_deleteAppServiceByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppServiceResult" } }, "x-mcp-annotations": { "title": "Delete Service", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteAppSubscriptionByUuid", "summary": "Delete Subscription", "description": "This API provides capability to delete user's Subscription\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appSubscriptionId", "description": "App Subscription UUID", "required": true, "schema": { "type": "string", "description": "App Subscription UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } } ], "result": { "name": "fabric_deleteAppSubscriptionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppSubscriptionResult" } }, "x-mcp-annotations": { "title": "Delete Subscription", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteAsnById", "summary": "Delete ASN", "description": "Deprovision ASN record by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "ASNs" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "asnId", "description": "UUID of the ASN record", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the ASN record" } } ], "result": { "name": "fabric_deleteAsnByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAsnResult" } }, "x-mcp-annotations": { "title": "Delete ASN", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteCloudRouterByUuid", "summary": "Delete Router", "description": "This API provides capability to delete user's Cloud Router\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_deleteCloudRouterByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Router", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteCloudRouterCommandByUuid", "summary": "Delete Command", "description": "This API provides capability to delete command based on command Id\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "commandId", "description": "Command UUID", "required": true, "schema": { "type": "string", "description": "Command UUID", "format": "uuid", "example": "37c10edc-ba2e-4240-a850-8a48f9c47d00" } } ], "result": { "name": "fabric_deleteCloudRouterCommandByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Command", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteCompanyProfile", "summary": "Delete Company Profile", "description": "Delete company profile by UUID Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } } ], "result": { "name": "fabric_deleteCompanyProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCompanyProfileResult" } }, "x-mcp-annotations": { "title": "Delete Company Profile", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteConnectionByUuid", "summary": "Delete Connection by ID", "description": "Delete Connection by ID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Connections" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Virtual Circuit UUID", "required": true, "schema": { "type": "string", "description": "Virtual Circuit UUID" } } ], "result": { "name": "fabric_deleteConnectionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionResult" } }, "x-mcp-annotations": { "title": "Delete Connection by ID", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteConnectionRoutingProtocolByUuid", "summary": "Delete Protocol", "description": "This API provides capability to delete Routing Protocols on virtual connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_deleteConnectionRoutingProtocolByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_a1b7bd9c" } }, "x-mcp-annotations": { "title": "Delete Protocol", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteEiaService", "summary": "Delete Internet Access Service by ID", "description": "Delete Internet Access Service by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Access Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the EIA Service", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the EIA Service" } } ], "result": { "name": "fabric_deleteEiaServiceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createEiaServiceResult" } }, "x-mcp-annotations": { "title": "Delete Internet Access Service by ID", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteIpBlockById", "summary": "Delete IP Block by ID", "description": "Delete IP Block by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "IP Blocks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the IP Block", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the IP Block" } } ], "result": { "name": "fabric_deleteIpBlockByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteIpBlockByIdResult" } }, "x-mcp-annotations": { "title": "Delete IP Block by ID", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteLogoByUuid", "summary": "Delete Logo", "description": "Delete Logo by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Logos" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the Logo", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the Logo" } } ], "result": { "name": "fabric_deleteLogoByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createLogoResult" } }, "x-mcp-annotations": { "title": "Delete Logo", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteNetworkByUuid", "summary": "Delete Network By ID", "description": "This API provides capability to delete user's Fabric Network\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "networkId", "description": "Network UUID", "required": true, "schema": { "type": "string", "description": "Network UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_deleteNetworkByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createNetworkResult_32127b47" } }, "x-mcp-annotations": { "title": "Delete Network By ID", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deletePort", "summary": "Delete Port", "description": "The API provides capability to delete a single port\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "portId", "description": "Port UUID", "required": true, "schema": { "type": "string", "description": "Port UUID", "format": "uuid" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } } ], "result": { "name": "fabric_deletePortResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createPortResult" } }, "x-mcp-annotations": { "title": "Delete Port", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteRouteAggregationByUuid", "summary": "Delete Aggregation", "description": "This API provides capability to delete a Route Aggregation\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } } ], "result": { "name": "fabric_deleteRouteAggregationByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationResult" } }, "x-mcp-annotations": { "title": "Delete Aggregation", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteRouteAggregationRuleByUuid", "summary": "Delete Route Aggregation Rule", "description": "This API provides capability to delete a Route aggregation Rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeAggregationRuleId", "description": "Route Aggregation Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregation Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } } ], "result": { "name": "fabric_deleteRouteAggregationRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationRuleResult" } }, "x-mcp-annotations": { "title": "Delete Route Aggregation Rule", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteRouteFilterByUuid", "summary": "Delete Route Filter", "description": "This API provides capability to delete a Route Filter\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } } ], "result": { "name": "fabric_deleteRouteFilterByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterResult" } }, "x-mcp-annotations": { "title": "Delete Route Filter", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteRouteFilterRuleByUuid", "summary": "Delete Route Filter Rule", "description": "This API provides capability to delete a Route Filter Rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeFilterRuleId", "description": "Route Filter Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Filter Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } } ], "result": { "name": "fabric_deleteRouteFilterRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterRuleResult" } }, "x-mcp-annotations": { "title": "Delete Route Filter Rule", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteServiceProfileByUuid", "summary": "Delete Service Profile", "description": "delete Service Profile by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } } ], "result": { "name": "fabric_deleteServiceProfileByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceProfileResult" } }, "x-mcp-annotations": { "title": "Delete Service Profile", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteServiceTokenByUuid", "summary": "Delete Service Token by ID", "description": "Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Tokens" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceTokenId", "description": "Service Token UUID", "required": true, "schema": { "type": "string", "description": "Service Token UUID", "format": "uuid" } } ], "result": { "name": "fabric_deleteServiceTokenByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceTokenResult" } }, "x-mcp-annotations": { "title": "Delete Service Token by ID", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteStreamAlertRuleByUuid", "summary": "Delete Stream Alert Rule", "description": "This API provides capability to delete a user's stream alert rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Alert Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "alertRuleId", "description": "Stream Alert Rule UUID", "required": true, "schema": { "type": "string", "description": "Stream Alert Rule UUID", "format": "uuid", "example": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15" } } ], "result": { "name": "fabric_deleteStreamAlertRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamAlertRulesResult" } }, "x-mcp-annotations": { "title": "Delete Stream Alert Rule", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteStreamAssetByUuid", "summary": "Detach Asset", "description": "This API provides capability to detach an asset from a stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "assetId", "description": "Stream Asset UUID", "required": true, "schema": { "type": "string", "description": "Stream Asset UUID", "format": "uuid", "example": "757400f8-d360-11e9-bb65-2a2ae2dbcce6" } }, { "name": "asset", "description": "asset", "required": true, "schema": { "enum": [ "ports", "connections", "routers", "metros", "organizations", "projects", "companyProfiles" ], "type": "string", "description": "asset" } }, { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } } ], "result": { "name": "fabric_deleteStreamAssetByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteStreamAssetByUuidResult" } }, "x-mcp-annotations": { "title": "Detach Asset", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteStreamByUuid", "summary": "Delete Stream", "description": "This API provides capability to delete user's stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } } ], "result": { "name": "fabric_deleteStreamByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamsResult" } }, "x-mcp-annotations": { "title": "Delete Stream", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteStreamDevice", "summary": "Detach Network Edge Device", "description": "This API provides capability to detach a Network Edge Device and all of its interfaces from a stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "deviceId", "description": "Network Edge Device UUID", "required": true, "schema": { "type": "string", "description": "Network Edge Device UUID", "format": "uuid", "example": "8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d" } } ], "result": { "name": "fabric_deleteStreamDeviceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteStreamAssetByUuidResult" } }, "x-mcp-annotations": { "title": "Detach Network Edge Device", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteStreamSubscriptionByUuid", "summary": "Delete Subscription", "description": "This API provides capability to delete user's Stream Subscriptions\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "subscriptionId", "description": "Stream Subscription UUID", "required": true, "schema": { "type": "string", "description": "Stream Subscription UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_deleteStreamSubscriptionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamSubscriptionsResult" } }, "x-mcp-annotations": { "title": "Delete Subscription", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_deleteTimeServiceById", "summary": "Delete Time Service by ID", "description": "The API provides capability to delete Precision Time Service by service id\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Precision Time Service UUID", "required": true, "schema": { "type": "string", "description": "Precision Time Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_deleteTimeServiceByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PrecisionTimeServiceResponse" } }, "x-mcp-annotations": { "title": "Delete Time Service by ID", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachAppDomainFromAppLink", "summary": "Detach Domain from Link", "description": "This API provides ability to detach App Domain from App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appDomainId", "description": "App Domain UUID", "required": true, "schema": { "type": "string", "description": "App Domain UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } } ], "result": { "name": "fabric_detachAppDomainFromAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppDomainToAppLinkResult" } }, "x-mcp-annotations": { "title": "Detach Domain from Link", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachAppProcessorFromAppLink", "summary": "Detach App Processor from App Link", "description": "This API provides ability to detach an App Processor from an App Link.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appProcessorId", "description": "App Processor UUID", "required": true, "schema": { "type": "string", "description": "App Processor UUID", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f" } } ], "result": { "name": "fabric_detachAppProcessorFromAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppProcessorToAppLinkResult" } }, "x-mcp-annotations": { "title": "Detach App Processor from App Link", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachAppServiceFromAppLink", "summary": "Detach Service from Link", "description": "This API provides ability to detach App Service from App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_detachAppServiceFromAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppServiceToAppLinkResult" } }, "x-mcp-annotations": { "title": "Detach Service from Link", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachConnectionRouteAggregation", "summary": "Detach Aggregation", "description": "This API provides capability to detach a Route Aggregation from a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_detachConnectionRouteAggregationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachConnectionRouteAggregationResult" } }, "x-mcp-annotations": { "title": "Detach Aggregation", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachConnectionRouteFilter", "summary": "Detach Route Filter", "description": "This API provides capability to detach a Route Filter from a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_detachConnectionRouteFilterResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachConnectionRouteFilterResult" } }, "x-mcp-annotations": { "title": "Detach Route Filter", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachPrivateServiceFromProfile", "summary": "Detach Private Service", "description": "Detach a private service from a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } }, { "name": "privateServiceId", "description": "Private Service UUID", "required": true, "schema": { "type": "string", "description": "Private Service UUID" } } ], "result": { "name": "fabric_detachPrivateServiceFromProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachPrivateServiceToProfileResult" } }, "x-mcp-annotations": { "title": "Detach Private Service", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachServiceProfileFromProfile", "summary": "Detach Service Profile", "description": "Detach a service profile from a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } }, { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID" } } ], "result": { "name": "fabric_detachServiceProfileFromProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachServiceProfileToProfileResult" } }, "x-mcp-annotations": { "title": "Detach Service Profile", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_detachTagFromProfile", "summary": "Detach Tag", "description": "Detach a tag from a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } }, { "name": "tagId", "description": "Tag UUID", "required": true, "schema": { "type": "string", "description": "Tag UUID" } } ], "result": { "name": "fabric_detachTagFromProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachTagToProfileResult" } }, "x-mcp-annotations": { "title": "Detach Tag", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_fulfillTimeServices", "summary": "Update Time Service", "description": "The API provides capability to Configure/Fulfill the Precision Time Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Precision Time Service UUID", "required": true, "schema": { "type": "string", "description": "Precision Time Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "description": "Precision Time Service Type refers to the corresponding Protocol.", "required": true, "schema": { "enum": [ "NTP", "PTP" ], "type": "string", "description": "Precision Time Service Type refers to the corresponding Protocol." } }, { "name": "name", "description": "Precision Time Service name.", "required": true, "schema": { "type": "string", "description": "Precision Time Service name." } }, { "name": "package", "description": "Precision Time Service Level Request", "required": true, "schema": { "$ref": "#/components/schemas/PrecisionTimePackageRequest" } }, { "name": "connections", "required": true, "schema": { "$ref": "#/components/schemas/Connections_d0aafdac" } }, { "name": "ipv4", "description": "EPT service network information", "required": true, "schema": { "$ref": "#/components/schemas/Ipv4_b8d452c8" } }, { "name": "ntpAdvancedConfiguration", "description": "NTP Advanced configuration - MD5 Authentication.", "required": false, "schema": { "$ref": "#/components/schemas/NtpAdvancedConfiguration" } }, { "name": "ptpAdvancedConfiguration", "description": "PTP Advanced Configuration.", "required": false, "schema": { "$ref": "#/components/schemas/PtpAdvancedConfiguration" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, { "name": "order", "description": "Precision Time Order", "required": false, "schema": { "$ref": "#/components/schemas/PrecisionTimeOrder" } } ], "result": { "name": "fabric_fulfillTimeServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PrecisionTimeServiceResponse" } }, "x-mcp-annotations": { "title": "Update Time Service", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAllCloudRouterCommands", "summary": "Get Commands", "description": "This API provides capability to fetch all commands\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getAllCloudRouterCommandsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_5b5fb9cb" } } }, "description": "List of Fabric Cloud Router Command", "x-fastmcp-top-level-schema": "GetAllCloudRouterCommands" } }, "x-mcp-annotations": { "title": "Get Commands", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAppDomainByUuid", "summary": "Get Domain", "description": "This API provides capability to retrieve user's Domain\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Domains" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appDomainId", "description": "App Domain UUID", "required": true, "schema": { "type": "string", "description": "App Domain UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } } ], "result": { "name": "fabric_getAppDomainByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppDomainResult" } }, "x-mcp-annotations": { "title": "Get Domain", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAppLinkByUuid", "summary": "Get Link", "description": "This API provides capability to retrieve user's Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } } ], "result": { "name": "fabric_getAppLinkByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppLinkResult" } }, "x-mcp-annotations": { "title": "Get Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAppProcessorByUuid", "summary": "Get Processor", "description": "This API provides capability to retrieve user's App Processor\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Processors" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appProcessorId", "description": "App Processor UUID", "required": true, "schema": { "type": "string", "description": "App Processor UUID", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f" } } ], "result": { "name": "fabric_getAppProcessorByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "type", "name", "registryId", "marketplace", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 1 }, "type": { "enum": [ "APP_PROCESSOR" ], "type": "string", "description": "App Processor Type", "default": "APP_PROCESSOR", "example": "APP_PROCESSOR", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 3 }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Customer-provided App Processor name", "format": "string", "example": "agent-gateway", "x-order": 4 }, "description": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Customer-provided App Processor description", "format": "string", "example": "llm-routing, a2a-routing, mcp-routing", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Processor lifecycle state", "format": "string", "example": "PROVISIONING", "x-order": 6 }, "registryId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Container image reference for the processor runtime", "format": "string", "example": "agentgateway/agentgateway:1.3.0", "x-order": 7 }, "marketplace": { "required": [ "visibility" ], "type": "object", "properties": { "visibility": { "enum": [ "PUBLIC", "PRIVATE" ], "type": "string", "description": "App Processor marketplace visibility", "format": "string", "default": "PUBLIC", "example": "PUBLIC" } }, "description": "App Processor marketplace settings", "x-order": 8 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_e92ba39a" } }, "description": "App Processor object", "x-fastmcp-top-level-schema": "AppProcessor" } }, "x-mcp-annotations": { "title": "Get Processor", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAppServiceByUuid", "summary": "Get Service", "description": "This API provides capability to retrieve user's Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getAppServiceByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppServiceResult" } }, "x-mcp-annotations": { "title": "Get Service", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAppSubscriptionByUuid", "summary": "Get Subscription", "description": "This API provides capability to retrieve user's Subscription\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appSubscriptionId", "description": "App Subscription UUID", "required": true, "schema": { "type": "string", "description": "App Subscription UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } } ], "result": { "name": "fabric_getAppSubscriptionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppSubscriptionResult" } }, "x-mcp-annotations": { "title": "Get Subscription", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAsnById", "summary": "Get ASN", "description": "Retrieve ASN record by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "ASNs" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "asnId", "description": "UUID of the ASN record", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the ASN record" } } ], "result": { "name": "fabric_getAsnByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAsnResult" } }, "x-mcp-annotations": { "title": "Get ASN", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppDomainByUuid", "summary": "Get Attached Domain for Link", "description": "This API provides ability to retrieve an App Domain attached to an App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appDomainId", "description": "App Domain UUID", "required": true, "schema": { "type": "string", "description": "App Domain UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } } ], "result": { "name": "fabric_getAttachedAppDomainByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppDomainToAppLinkResult" } }, "x-mcp-annotations": { "title": "Get Attached Domain for Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppDomainsByAppLinkId", "summary": "Get Attached Domains for Link", "description": "This API provides capability to retrieve App Domains attached to an App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } }, { "name": "attachmentStatus", "description": "Filter attached App Domains by attachment lifecycle state.", "required": false, "schema": { "type": "array", "items": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "description": "Filter attached App Domains by attachment lifecycle state.", "example": [ "ATTACHED", "ATTACHING" ] } }, { "name": "order", "description": "Sort order for attached App Domains.", "required": false, "schema": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sort order for attached App Domains.", "default": "DESC", "example": "DESC" } }, { "name": "style", "description": "Detail level of the response.", "required": false, "schema": { "enum": [ "MIN", "MEDIUM", "FULL" ], "type": "string", "description": "Detail level of the response.", "default": "MEDIUM", "example": "MEDIUM" } } ], "result": { "name": "fabric_getAttachedAppDomainsByAppLinkIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_DOMAIN" ], "type": "string", "description": "App Domain Type", "default": "APP_DOMAIN", "example": "APP_DOMAIN", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Domain name", "format": "string", "example": "atlassian.net", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Domain description", "format": "string", "example": "Atlassian Domain", "x-order": 5 }, "state": { "enum": [ "PENDING_VERIFICATION", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED" ], "type": "string", "description": "App Domain lifecycle state", "format": "string", "example": "PENDING_VERIFICATION", "x-order": 6 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 } }, "description": "App Domain object associated with App Link" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppLinkAttachedAppDomains" } }, "x-mcp-annotations": { "title": "Get Attached Domains for Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppLinksByAppDomainId", "summary": "Get Attached Links for Domain", "description": "This API provides capability to retrieve App Links attached to an App Domain\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Domains" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appDomainId", "description": "App Domain UUID", "required": true, "schema": { "type": "string", "description": "App Domain UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } }, { "name": "state", "description": "Filter attached App Links by lifecycle state.", "required": false, "schema": { "$ref": "#/components/schemas/State_f029ca86" } }, { "name": "order", "description": "Sort order for attached App Links.", "required": false, "schema": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sort order for attached App Links.", "default": "DESC", "example": "DESC" } }, { "name": "style", "description": "Detail level of the response.", "required": false, "schema": { "enum": [ "MIN", "MEDIUM", "FULL" ], "type": "string", "description": "Detail level of the response.", "default": "MEDIUM", "example": "MEDIUM" } } ], "result": { "name": "fabric_getAttachedAppLinksByAppDomainIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 1 }, "type": { "enum": [ "APP_LINK" ], "type": "string", "description": "App Link Type", "default": "APP_LINK", "example": "APP_LINK", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Link name", "format": "string", "example": "Atlassian App Link", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Link description", "format": "string", "example": "Atlassian App Link in SV", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Link lifecycle state", "format": "string", "example": "PROVISIONING", "x-order": 6 }, "router": { "$ref": "#/components/schemas/Router_81684de7" }, "ipv4Subnet": { "type": "string", "description": "Customer-provided IP subnet for AppLink setup (/29 or larger subnet)", "example": "192.168.10.0/29", "x-order": 8 }, "ipv4Address": { "type": "string", "description": "App Link IP address", "format": "ipv4", "example": "192.168.10.1", "x-order": 9 }, "bandwidth": { "type": "integer", "description": "App Link aggregated data transfer capacity in Mbps", "example": 1000, "x-order": 10 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, "description": "App Link object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppDomainAttachedAppLinks" } }, "x-mcp-annotations": { "title": "Get Attached Links for Domain", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppLinksByAppServiceId", "summary": "Get Attached Links for Service", "description": "This API provides capability to retrieve App Links attached to an App Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } }, { "name": "state", "description": "Filter attached App Links by lifecycle state.", "required": false, "schema": { "$ref": "#/components/schemas/State_f029ca86" } }, { "name": "order", "description": "Sort order for attached App Links.", "required": false, "schema": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sort order for attached App Links.", "default": "DESC", "example": "DESC" } }, { "name": "style", "description": "Detail level of the response.", "required": false, "schema": { "enum": [ "MIN", "MEDIUM", "FULL" ], "type": "string", "description": "Detail level of the response.", "default": "MEDIUM", "example": "MEDIUM" } } ], "result": { "name": "fabric_getAttachedAppLinksByAppServiceIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 1 }, "type": { "enum": [ "APP_LINK" ], "type": "string", "description": "App Link Type", "default": "APP_LINK", "example": "APP_LINK", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Link name", "format": "string", "example": "Atlassian App Link", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Link description", "format": "string", "example": "Atlassian App Link in SV", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Link lifecycle state", "format": "string", "example": "PROVISIONING", "x-order": 6 }, "router": { "$ref": "#/components/schemas/Router_81684de7" }, "ipv4Subnet": { "type": "string", "description": "Customer-provided IP subnet for AppLink setup (/29 or larger subnet)", "example": "192.168.10.0/29", "x-order": 8 }, "ipv4Address": { "type": "string", "description": "App Link IP address", "format": "ipv4", "example": "192.168.10.1", "x-order": 9 }, "bandwidth": { "type": "integer", "description": "App Link aggregated data transfer capacity in Mbps", "example": 1000, "x-order": 10 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } }, "description": "App Link object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppServiceAttachedAppLinks" } }, "x-mcp-annotations": { "title": "Get Attached Links for Service", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppProcessor", "summary": "Get attached App Processor for App Link", "description": "This API provides ability to get an App Processor attached to an App Link.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appProcessorId", "description": "App Processor UUID", "required": true, "schema": { "type": "string", "description": "App Processor UUID", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f" } } ], "result": { "name": "fabric_getAttachedAppProcessorResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppProcessorToAppLinkResult" } }, "x-mcp-annotations": { "title": "Get attached App Processor for App Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppProcessorsByAppLinkId", "summary": "Get attached Processors for Link", "description": "This API provides capability to retrieve App Processors attached to an App Link.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } }, { "name": "attachmentStatus", "description": "Filter attached App Processors by attachment lifecycle state.", "required": false, "schema": { "type": "array", "items": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "description": "Filter attached App Processors by attachment lifecycle state.", "example": [ "ATTACHED", "ATTACHING" ] } }, { "name": "order", "description": "Sort order for attached App Processors.", "required": false, "schema": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sort order for attached App Processors.", "default": "DESC", "example": "DESC" } }, { "name": "style", "description": "Detail level of the response.", "required": false, "schema": { "enum": [ "MIN", "MEDIUM", "FULL" ], "type": "string", "description": "Detail level of the response.", "default": "MEDIUM", "example": "MEDIUM" } } ], "result": { "name": "fabric_getAttachedAppProcessorsByAppLinkIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_3f870086" } }, "x-fastmcp-top-level-schema": "AppLinkAttachedAppProcessors" } }, "x-mcp-annotations": { "title": "Get attached Processors for Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppServiceByUuid", "summary": "Get Attached Service for Link", "description": "This API provides ability to retrieve an App Service attached to an App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getAttachedAppServiceByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppServiceToAppLinkResult" } }, "x-mcp-annotations": { "title": "Get Attached Service for Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppServicesByAppLinkId", "summary": "Get Attached Services for Link", "description": "This API provides capability to retrieve App Services attached to an App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } }, { "name": "attachmentStatus", "description": "Filter attached App Services by attachment lifecycle state.", "required": false, "schema": { "type": "array", "items": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "description": "Filter attached App Services by attachment lifecycle state.", "example": [ "ATTACHED", "ATTACHING" ] } }, { "name": "order", "description": "Sort order for attached App Services.", "required": false, "schema": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sort order for attached App Services.", "default": "DESC", "example": "DESC" } }, { "name": "style", "description": "Detail level of the response.", "required": false, "schema": { "enum": [ "MIN", "MEDIUM", "FULL" ], "type": "string", "description": "Detail level of the response.", "default": "MEDIUM", "example": "MEDIUM" } } ], "result": { "name": "fabric_getAttachedAppServicesByAppLinkIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "uuid", "geoScope", "destinationIp" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 1 }, "type": { "enum": [ "APP_SERVICE" ], "type": "string", "description": "App Service Type", "default": "APP_SERVICE", "example": "APP_SERVICE", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Service name", "format": "string", "example": "Atlassian App Service", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Service description", "format": "string", "example": "Atlassian App Service in SV", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Service lifecycle state", "example": "PROVISIONING", "x-order": 6 }, "endpoint": { "type": "string", "description": "Accessible endpoint through this service", "example": "equinixjira.atlassian.net", "x-order": 7 }, "sourceDomains": { "type": "array", "items": { "type": "string", "example": "equinix.com" }, "description": "List of source domains from where traffic is allowed", "x-order": 8 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "geoScope": { "type": "string", "description": "Geo scope for the App Service", "example": "GLOBAL", "x-order": 4 }, "destinationIp": { "type": "string", "description": "Target IP for forwarding API requests", "format": "ipv4", "example": "10.10.1.110", "x-order": 5 }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 } }, "description": "App Service object associated with App Link" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppLinkAttachedAppServices" } }, "x-mcp-annotations": { "title": "Get Attached Services for Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getAttachedAppSubscriptionsByAppServiceId", "summary": "Get Attached Subscriptions for Service", "description": "This API provides capability to retrieve App Subscriptions attached to an App Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } }, { "name": "state", "description": "Filter attached App Subscriptions by lifecycle state.", "required": false, "schema": { "type": "array", "items": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Subscription lifecycle state", "example": "PROVISIONING", "x-order": 6 }, "description": "Filter attached App Subscriptions by lifecycle state.", "example": [ "PROVISIONED", "PROVISIONING" ] } }, { "name": "order", "description": "Sort order for attached App Subscriptions.", "required": false, "schema": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sort order for attached App Subscriptions.", "default": "DESC", "example": "DESC" } }, { "name": "style", "description": "Detail level of the response.", "required": false, "schema": { "enum": [ "MIN", "MEDIUM", "FULL" ], "type": "string", "description": "Detail level of the response.", "default": "MEDIUM", "example": "MEDIUM" } } ], "result": { "name": "fabric_getAttachedAppSubscriptionsByAppServiceIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_17ed86c9" } }, "x-fastmcp-top-level-schema": "AppServiceAttachedAppSubscriptions" } }, "x-mcp-annotations": { "title": "Get Attached Subscriptions for Service", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudEvent", "summary": "Get Cloud Event", "description": "This API provides capability to retrieve a cloud event by uuid\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Events" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "cloudEventId", "description": "Cloud Event UUID", "required": true, "schema": { "type": "string", "description": "Cloud Event UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getCloudEventResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "specversion": { "type": "string", "description": "Cloud Event Open Telemetry specification" }, "source": { "type": "string", "description": "Cloud Event source" }, "id": { "type": "string", "description": "Cloud Event identifier", "format": "uuid" }, "type": { "type": "string", "description": "Equinix supported event type" }, "subject": { "type": "string", "description": "Cloud Event subject" }, "time": { "type": "string", "description": "Cloud Event time the event occurred", "format": "date-time" }, "dataschema": { "type": "string", "description": "Cloud Event dataschema reference" }, "datacontenttype": { "type": "string", "description": "Cloud Event data content type" }, "severitynumber": { "type": "string", "description": "Cloud Event severity number" }, "severitytext": { "type": "string", "description": "Cloud Event severity text" }, "equinixalert": { "type": "string", "description": "Equinix alert" }, "equinixorganization": { "type": "string", "description": "Equinix organization identifier" }, "equinixproject": { "type": "string", "description": "Equinix project identifier" }, "authtype": { "type": "string", "description": "Cloud Event auth type" }, "authid": { "type": "string", "description": "Cloud Event user identifier" }, "traceparent": { "type": "string", "description": "Cloud Event traceparent" }, "tracestate": { "type": "string", "description": "Cloud Event tracestate" }, "data": { "$ref": "#/components/schemas/Data_484c9827" } }, "description": "Cloud Event object", "x-fastmcp-top-level-schema": "CloudEvent" } }, "x-mcp-annotations": { "title": "Get Cloud Event", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudEventByAssetId", "summary": "Get Cloud Events by Asset Id (Deprecated)", "description": "Deprecated: this operation may be removed. Prefer a non-deprecated alternative where one exists.\n\nThis API provides capability to retrieve cloud events of an asset id\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Events" }, { "name": "deprecated" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "asset", "description": "asset", "required": true, "schema": { "enum": [ "ports", "connections", "routers", "metros", "serviceTokens", "networks", "projects", "organizations", "timeServices", "companyProfiles" ], "type": "string", "description": "asset" } }, { "name": "assetId", "description": "Asset UUID", "required": true, "schema": { "type": "string", "description": "Asset UUID", "format": "uuid", "example": "757400f8-d360-11e9-bb65-2a2ae2dbcce6" } }, { "name": "fromDateTime", "description": "Start date and time", "required": false, "schema": { "type": "string", "description": "Start date and time", "format": "date-time", "example": "2024-07-11T18:06:21.000Z" } }, { "name": "toDateTime", "description": "End date and time", "required": false, "schema": { "type": "string", "description": "End date and time", "format": "date-time", "example": "2024-07-11T18:06:21.000Z" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "type": "integer", "description": "Pagination offset", "default": 0, "example": 0 } }, { "name": "limit", "description": "Pagination limit", "required": false, "schema": { "type": "integer", "description": "Pagination limit", "default": 100, "example": 20 } } ], "result": { "name": "fabric_getCloudEventByAssetIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getCloudEventByAssetIdResult" } }, "x-mcp-annotations": { "title": "Get Cloud Events by Asset Id (Deprecated)", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudRouterActions", "summary": "Get Route Table Actions", "description": "This API provides capability to fetch all actions for a given cloud router\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "state", "description": "Cloud router action state", "required": false, "schema": { "enum": [ "SUCCEEDED", "FAILED", "PENDING" ], "type": "string", "description": "Cloud router action state" } } ], "result": { "name": "fabric_getCloudRouterActionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getCloudRouterActionsResult" } }, "x-mcp-annotations": { "title": "Get Route Table Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudRouterActionsByUuid", "summary": "Get Route Table Action by ID", "description": "This API provides capability to fetch action status\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "actionId", "description": "Action UUID", "required": true, "schema": { "type": "string", "description": "Action UUID", "format": "uuid", "example": "457400f8-d360-11e9-bb65-2a2ae2dbcced" } }, { "name": "state", "description": "Cloud router action state", "required": false, "schema": { "enum": [ "SUCCEEDED", "FAILED", "PENDING" ], "type": "string", "description": "Cloud router action state" } } ], "result": { "name": "fabric_getCloudRouterActionsByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCloudRouterActionResult" } }, "x-mcp-annotations": { "title": "Get Route Table Action by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudRouterByUuid", "summary": "Get Router", "description": "This API provides capability to retrieve user's Cloud Router\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getCloudRouterByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "type": { "enum": [ "IC_ROUTER", "XF_ROUTER" ], "type": "string" }, "name": { "type": "string", "description": "Customer-provided Cloud Router name" }, "location": { "$ref": "#/components/schemas/Location_32724e48" }, "package": { "$ref": "#/components/schemas/Package" }, "order": { "$ref": "#/components/schemas/Order_3e7328e1" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_903ff2b6" }, "href": { "type": "string", "description": "Cloud Routers URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "state": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "REPROVISIONING", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Access point lifecycle state", "example": "PROVISIONED" }, "equinixAsn": { "type": "integer", "description": "Equinix ASN", "format": "int64", "example": 30000 }, "connectionsCount": { "minimum": 0.0, "type": "integer", "description": "Number of connections associated with this Access point" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_3a596f52" } }, "description": "Fabric Cloud Router read response object", "x-fastmcp-top-level-schema": "CloudRouterReadResponse" } }, "x-mcp-annotations": { "title": "Get Router", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudRouterCommand", "summary": "Get Command", "description": "This API provides capability to fetch command using command Id\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "commandId", "description": "Command UUID", "required": true, "schema": { "type": "string", "description": "Command UUID", "format": "uuid", "example": "37c10edc-ba2e-4240-a850-8a48f9c47d00" } } ], "result": { "name": "fabric_getCloudRouterCommandResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCloudRouterCommandResult" } }, "x-mcp-annotations": { "title": "Get Command", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudRouterPackageByCode", "summary": "Get Package Details", "description": "This API provides capability to retrieve user's Cloud Routers Package Details\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Router Packages" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerPackageCode", "description": "Router package code", "required": true, "schema": { "enum": [ "LAB", "BASIC", "STANDARD", "ADVANCED", "PREMIUM" ], "type": "string", "description": "Router package code" } } ], "result": { "name": "fabric_getCloudRouterPackageByCodeResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "href": { "type": "string", "description": "Cloud Router package URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routerPackages/LAB" }, "type": { "enum": [ "ROUTER_PACKAGE" ], "type": "string", "description": "Type of Router package", "example": "ROUTER_PACKAGE" }, "code": { "enum": [ "LAB", "BASIC", "STANDARD", "ADVANCED", "PREMIUM" ], "type": "string", "description": "Cloud Router package code", "example": "LAB" }, "description": { "type": "string", "description": "Fabric Cloud Router Package description" }, "totalIPv4RoutesMax": { "minimum": 0.0, "type": "integer", "description": "Cloud Router package BGP IPv4 routes limit", "example": 50 }, "totalIPv6RoutesMax": { "minimum": 0.0, "type": "integer", "description": "Cloud Router package BGP IPv6 routes limit", "example": 50 }, "routeFilterSupported": { "type": "boolean", "description": "CloudRouter package route filter support" }, "vcCountMax": { "minimum": 0.0, "type": "integer", "description": "CloudRouter package Max Connection limit", "example": 10 }, "crCountMax": { "minimum": 0.0, "type": "integer", "description": "CloudRouter package Max CloudRouter limit", "example": 3 }, "vcBandwidthMax": { "minimum": 0.0, "type": "integer", "description": "CloudRouter package Max Bandwidth limit", "example": 50 }, "changeLog": { "type": "object", "properties": { "createdDateTime": { "type": "string", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, "description": "Cloud Router package change log" } }, "description": "Fabric Cloud Router Package", "x-fastmcp-top-level-schema": "CloudRouterPackage" } }, "x-mcp-annotations": { "title": "Get Package Details", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCloudRouterPackages", "summary": "List Packages", "description": "This API provides capability to retrieve user's Cloud Routers Packages\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Router Packages" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getCloudRouterPackagesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Cloud Router package URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routerPackages/LAB" }, "type": { "enum": [ "ROUTER_PACKAGE" ], "type": "string", "description": "Type of Router package", "example": "ROUTER_PACKAGE" }, "code": { "enum": [ "LAB", "BASIC", "STANDARD", "ADVANCED", "PREMIUM" ], "type": "string", "description": "Cloud Router package code", "example": "LAB" }, "description": { "type": "string", "description": "Fabric Cloud Router Package description" }, "totalIPv4RoutesMax": { "minimum": 0.0, "type": "integer", "description": "Cloud Router package BGP IPv4 routes limit", "example": 50 }, "totalIPv6RoutesMax": { "minimum": 0.0, "type": "integer", "description": "Cloud Router package BGP IPv6 routes limit", "example": 50 }, "routeFilterSupported": { "type": "boolean", "description": "CloudRouter package route filter support" }, "vcCountMax": { "minimum": 0.0, "type": "integer", "description": "CloudRouter package Max Connection limit", "example": 10 }, "crCountMax": { "minimum": 0.0, "type": "integer", "description": "CloudRouter package Max CloudRouter limit", "example": 3 }, "vcBandwidthMax": { "minimum": 0.0, "type": "integer", "description": "CloudRouter package Max Bandwidth limit", "example": 50 }, "changeLog": { "type": "object", "properties": { "createdDateTime": { "type": "string", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, "description": "Cloud Router package change log" } }, "description": "Fabric Cloud Router Package" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "PackageResponse" } }, "x-mcp-annotations": { "title": "List Packages", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCompanyProfile", "summary": "Get Company Profile by ID", "description": "Get company profile details by UUID Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } } ], "result": { "name": "fabric_getCompanyProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCompanyProfileResult" } }, "x-mcp-annotations": { "title": "Get Company Profile by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCompanyProfilePrivateServices", "summary": "Get Private Services", "description": "Get all private services attached to a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } } ], "result": { "name": "fabric_getCompanyProfilePrivateServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string" } } }, "description": "List of private services", "example": [ { "href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387", "uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387" } ] } }, "x-fastmcp-top-level-schema": "PrivateServiceListResponse" } }, "x-mcp-annotations": { "title": "Get Private Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCompanyProfileServiceProfiles", "summary": "Get Service Profiles", "description": "Get all service profiles attached to a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } } ], "result": { "name": "fabric_getCompanyProfileServiceProfilesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string" }, "type": { "enum": [ "L2_PROFILE", "L3_PROFILE", "IA_PROFILE", "IX_PROFILE", "IC_PROFILE", "LMAAS_PROFILE" ], "type": "string", "description": "Service profile type", "example": "L2_PROFILE", "x-eqx-api-linter-skip-rules": [ 40 ] } } }, "description": "List of service profiles", "example": [ { "href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387", "uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387" } ] } }, "x-fastmcp-top-level-schema": "ServiceProfileListResponse" } }, "x-mcp-annotations": { "title": "Get Service Profiles", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionByUuid", "summary": "Get Connection by ID", "description": "The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Connections" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "direction", "description": "Connection directionality from the requester point of view", "required": false, "schema": { "enum": [ "INTERNAL", "INCOMING", "OUTGOING" ], "type": "string", "description": "Connection directionality from the requester point of view" } } ], "result": { "name": "fabric_getConnectionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionResult" } }, "x-mcp-annotations": { "title": "Get Connection by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRouteAggregationByUuid", "summary": "Get Aggregation", "description": "This API provides capability to view a specific Route Aggregation attached to a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getConnectionRouteAggregationByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachConnectionRouteAggregationResult" } }, "x-mcp-annotations": { "title": "Get Aggregation", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRouteAggregations", "summary": "Get Connection Route Aggregations", "description": "This API provides capability to view all Route Aggregations attached to a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getConnectionRouteAggregationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_0b2bd7bb" }, "description": "List of Route Aggregations attached to a Connection" } }, "x-fastmcp-top-level-schema": "GetAllConnectionRouteAggregationsResponse" } }, "x-mcp-annotations": { "title": "Get Connection Route Aggregations", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRouteFilterByUuid", "summary": "Get Route Filter", "description": "This API provides capability to view a specific Route Filter attached to a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getConnectionRouteFilterByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachConnectionRouteFilterResult" } }, "x-mcp-annotations": { "title": "Get Route Filter", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRouteFilters", "summary": "Get Connection Route Filters", "description": "This API provides capability to view all Route Filters attached to a Connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getConnectionRouteFiltersResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_2cd3d0bb" }, "description": "List of Route Filters attached to a Connection" } }, "x-fastmcp-top-level-schema": "GetAllConnectionRouteFiltersResponse" } }, "x-mcp-annotations": { "title": "Get Connection Route Filters", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRoutingProtocolAllBgpActions", "summary": "Get BGP Actions", "description": "This API provides capability to get all BGP actions status\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getConnectionRoutingProtocolAllBgpActionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Routing Protocol URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5/actions" }, "uuid": { "type": "string", "description": "Routing protocol identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "CLEAR_BGPIPV4", "CLEAR_BGPIPV6", "CLEAR_BGPIPV4_INBOUND", "CLEAR_BGPIPV6_INBOUND", "RESET_BGPIPV4", "RESET_BGPIPV6" ], "type": "string", "description": "BGP action type" }, "description": { "type": "string", "description": "BGP action description" }, "state": { "enum": [ "PENDING", "FAILED", "SUCCEEDED" ], "type": "string", "description": "BGP action state" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } } } }, "description": "List of BGP Actions", "x-fastmcp-top-level-schema": "BGPActionsBulkData" } }, "x-mcp-annotations": { "title": "Get BGP Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRoutingProtocolByUuid", "summary": "Get Protocol", "description": "This API provides capability to accept/reject user's virtual connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getConnectionRoutingProtocolByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_a1b7bd9c" } }, "x-mcp-annotations": { "title": "Get Protocol", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRoutingProtocols", "summary": "Get Routing Protocols", "description": "This API provides capability to get Routing Protocols for connections\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getConnectionRoutingProtocolsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolsInBulkResult" } }, "x-mcp-annotations": { "title": "Get Routing Protocols", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRoutingProtocolsBgpActionByUuid", "summary": "Get BGP Action", "description": "This API provides capability to retrieve specific BGP action\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "actionId", "description": "BGP Action UUID", "required": true, "schema": { "type": "string", "description": "BGP Action UUID", "format": "uuid", "example": "86534014-34b4-53f6-45d6-4b94a92d8623" } } ], "result": { "name": "fabric_getConnectionRoutingProtocolsBgpActionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getConnectionRoutingProtocolsBgpActionByUuidResult" } }, "x-mcp-annotations": { "title": "Get BGP Action", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRoutingProtocolsChangeByUuid", "summary": "Get Change By ID", "description": "This API provides capability to retrieve specific Routing Protocol Change\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "changeId", "description": "Routing Protocol Change UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol Change UUID", "format": "uuid", "example": "6d500177-9404-41f2-99e8-2bf1a84d8db5" } } ], "result": { "name": "fabric_getConnectionRoutingProtocolsChangeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_7f4a8672" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_30d132ad" } }, "description": "Current state of latest Routing Protocol change", "x-fastmcp-top-level-schema": "RoutingProtocolChangeData" } }, "x-mcp-annotations": { "title": "Get Change By ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionRoutingProtocolsChanges", "summary": "Get Routing Protocol Changes", "description": "This API provides capability to retrieve user's Routing Protocol Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getConnectionRoutingProtocolsChangesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_7f4a8672" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_30d132ad" } }, "description": "Current state of latest Routing Protocol change" } } }, "description": "List of network changes", "x-fastmcp-top-level-schema": "RoutingProtocolChangeDataResponse" } }, "x-mcp-annotations": { "title": "Get Routing Protocol Changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionStatsByPortUuid", "summary": "Get Stats by ID (DEPRECATED)", "description": "Deprecated: this operation may be removed. Prefer a non-deprecated alternative where one exists.\n\nThis API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity **(DEPRECATED)**\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Statistics" }, { "name": "deprecated" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Virtual Circuit UUID", "required": true, "schema": { "type": "string", "description": "Virtual Circuit UUID" } }, { "name": "startDateTime", "description": "startDateTime", "required": true, "schema": { "type": "string", "description": "startDateTime", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, { "name": "endDateTime", "description": "endDateTime", "required": true, "schema": { "type": "string", "description": "endDateTime", "format": "date-time", "example": "2020-11-10T07:00:00Z" } }, { "name": "viewPoint", "description": "viewPoint", "required": true, "schema": { "enum": [ "aSide", "zSide" ], "type": "string", "description": "viewPoint", "example": "aSide" } } ], "result": { "name": "fabric_getConnectionStatsByPortUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getConnectionStatsByPortUuidResult" } }, "x-mcp-annotations": { "title": "Get Stats by ID (DEPRECATED)", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getConnectionsByNetworkUuid", "summary": "Get Connections", "description": "The API provides capability to get list of user's Fabric Network connections\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "networkId", "description": "Network UUID", "required": true, "schema": { "type": "string", "description": "Network UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getConnectionsByNetworkUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_2d124c60" } }, "description": "List of network changes", "x-fastmcp-top-level-schema": "NetworkConnections" } }, "x-mcp-annotations": { "title": "Get Connections", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCrossConnectActionByUuid", "summary": "Get Cross Connect Action by Action ID", "description": "The API provides capability to fetch Cross Connect action details by Action ID.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } }, { "name": "actionId", "description": "Cross Connect Action UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect Action UUID.", "format": "uuid", "example": "30cc7878-54e3-4e1a-8651-87a61354bad4" } } ], "result": { "name": "fabric_getCrossConnectActionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getCrossConnectActionByUuidResult" } }, "x-mcp-annotations": { "title": "Get Cross Connect Action by Action ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCrossConnectAttachmentsByUuid", "summary": "Get Cross Connect Attachments", "description": "The API provides capability to get the documents attached to a Cross Connect by Cross Connect ID.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } } ], "result": { "name": "fabric_getCrossConnectAttachmentsByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "URI to the attachment resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Attachment resource Identifier.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "type": { "enum": [ "ATTACHMENT" ], "type": "string", "description": "Sub-resource type.", "example": "ATTACHMENT" }, "source": { "enum": [ "CUSTOMER", "EQUINIX" ], "type": "string", "description": "Attachment Source.", "example": "CUSTOMER" }, "attachmentId": { "type": "string", "description": "Attachment Identifier.", "format": "uuid", "example": "a11f485e-3094-42de-8797-0ef19a51df79" }, "downloadHref": { "type": "string", "description": "URI to download the attachment file content from the Equinix attachment service.\n", "format": "uri", "example": "https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_a9aa0994" } }, "description": "Document attached to a Cross Connect." } } }, "description": "List of documents attached to the Cross Connect.", "x-fastmcp-top-level-schema": "CrossConnectAttachmentsResponse" } }, "x-mcp-annotations": { "title": "Get Cross Connect Attachments", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCrossConnectByUuid", "summary": "Get Cross Connect", "description": "The API provides capability to get Cross Connect details by Cross Connect ID.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } } ], "result": { "name": "fabric_getCrossConnectByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCrossConnectResult" } }, "x-mcp-annotations": { "title": "Get Cross Connect", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCrossConnectNotesByUuid", "summary": "Get Cross Connect Notes", "description": "The API provides capability to get the notes added to a Cross Connect by Cross Connect ID.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getCrossConnectNotesByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Note URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Note Identifier.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "type": { "enum": [ "NOTE" ], "type": "string", "description": "Sub-resource type.", "example": "NOTE" }, "source": { "enum": [ "CUSTOMER", "EQUINIX" ], "type": "string", "description": "Party that added the note.", "example": "CUSTOMER" }, "comments": { "maxLength": 4000, "type": "string", "description": "Note comments.", "example": "this is reply to the technician note." }, "parentNote": { "$ref": "#/components/schemas/ParentNote_1a60856f" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_a9aa0994" } }, "description": "Cross Connect Note." } } }, "description": "List of notes added to the Cross Connect.", "x-fastmcp-top-level-schema": "CrossConnectNotesResponse" } }, "x-mcp-annotations": { "title": "Get Cross Connect Notes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCrossConnectSchedulesByUuid", "summary": "Get Cross Connect Schedules", "description": "The API provides capability to get the schedules of a Cross Connect by Cross Connect ID.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } } ], "result": { "name": "fabric_getCrossConnectSchedulesByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule_9533c530" } } }, "description": "Schedules of the Cross Connect.", "x-fastmcp-top-level-schema": "SchedulesResponse" } }, "x-mcp-annotations": { "title": "Get Cross Connect Schedules", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getCrossConnectServicesByUuid", "summary": "Get Cross Connect Services", "description": "The API provides capability to get the services ordered alongside a Cross Connect by Cross Connect ID.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } } ], "result": { "name": "fabric_getCrossConnectServicesByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ServicesItem_82149230" } } }, "description": "List of services ordered alongside the Cross Connect.", "x-fastmcp-top-level-schema": "CrossConnectServicesResponse" } }, "x-mcp-annotations": { "title": "Get Cross Connect Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getEiaService", "summary": "Get Internet Access Service by ID", "description": "Retrieve Internet Access Service by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Access Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the EIA Service", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the EIA Service" } } ], "result": { "name": "fabric_getEiaServiceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createEiaServiceResult" } }, "x-mcp-annotations": { "title": "Get Internet Access Service by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getExchangeServiceById", "summary": "Get Internet Exchange Service", "description": "The API provides capability to get Internet Exchange Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Exchange Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "exchangeServiceId", "description": "Internet Exchange Service UUID", "required": true, "schema": { "type": "string", "description": "Internet Exchange Service UUID", "format": "uuid", "example": "a8ba52de-faae-43b5-b0b1-6904d37ee011" } } ], "result": { "name": "fabric_getExchangeServiceByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createExchangeServiceResult" } }, "x-mcp-annotations": { "title": "Get Internet Exchange Service", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getIpBlock", "summary": "Retrieve IP Block by ID", "description": "Retrieve IP Block by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "IP Blocks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the IP Block", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the IP Block" } } ], "result": { "name": "fabric_getIpBlockResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteIpBlockByIdResult" } }, "x-mcp-annotations": { "title": "Retrieve IP Block by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getLoaActionsByUuid", "summary": "Get Loa Action by Action ID", "description": "This API provides capability to fetch action details\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } }, { "name": "actionId", "description": "Action UUID", "required": true, "schema": { "type": "string", "description": "Action UUID", "format": "uuid", "example": "30cc7878-54e3-4e1a-8651-87a61354bad4" } } ], "result": { "name": "fabric_getLoaActionsByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getLoaActionsByUuidResult" } }, "x-mcp-annotations": { "title": "Get Loa Action by Action ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getLoaByUuid", "summary": "Get Loa", "description": "The API provides capability to get Loa details by Loa ID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } } ], "result": { "name": "fabric_getLoaByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createLoaResult" } }, "x-mcp-annotations": { "title": "Get Loa", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getLoaConsumersByLoaId", "summary": "Get Loa Consumers", "description": "The API provides capability to get Loa consumers by Loa ID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } } ], "result": { "name": "fabric_getLoaConsumersByLoaIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Consumer URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2" }, "uuid": { "type": "string", "description": "Consumer Identifier", "format": "uuid", "example": "30cc7878-54e3-4e1a-8651-87a61354bad4" }, "type": { "enum": [ "XC", "XF_PORT", "VD" ], "type": "string", "description": "Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge\n", "example": "XC" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_c32c50f9" } }, "description": "Associated consumer response" } } }, "description": "List of Consumers associated with a LOA", "x-fastmcp-top-level-schema": "LoaConsumersResponse" } }, "x-mcp-annotations": { "title": "Get Loa Consumers", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getLoaNotesByUuid", "summary": "Get Loa Notes", "description": "The API provides capability to get Loa notes by Loa ID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } } ], "result": { "name": "fabric_getLoaNotesByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "ISSUER", "REQUESTOR" ], "type": "string", "description": "Indicates which party added the note.
ISSUER — note was added by a user from the issuer organization.
REQUESTOR — note was added by a user from the requestor organization.\n", "example": "ISSUER" }, "href": { "type": "string", "description": "URI to note resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/loas/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306/notes/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Unique identifier of this note.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "comments": { "type": "string", "description": "Content of the note as submitted by the user.", "example": "LOA under review by our team. Expected response within 2 business days" }, "createdDateTime": { "type": "string", "description": "Date and time when the note was created.", "format": "date-time", "example": "2023-08-01T12:34:56Z" } }, "description": "Represents a note added to a LOA by an authorized user from either the issuer or requestor organization\n" } } }, "description": "List of Loa note details", "x-fastmcp-top-level-schema": "LoaNotesResponse" } }, "x-mcp-annotations": { "title": "Get Loa Notes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getLogoByUuid", "summary": "Get Logo", "description": "Get Logo by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Logos" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the Logo", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the Logo" } } ], "result": { "name": "fabric_getLogoByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "string", "format": "binary" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get Logo", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getMetricByAssetId", "summary": "Get Metrics by Asset Id (Deprecated)", "description": "Deprecated: this operation may be removed. Prefer a non-deprecated alternative where one exists.\n\nThis API provides capability to retrieve Metrics of an asset id\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Metrics" }, { "name": "deprecated" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "asset", "description": "asset", "required": true, "schema": { "enum": [ "ports", "connections", "metros" ], "type": "string", "description": "asset" } }, { "name": "assetId", "description": "Asset UUID", "required": true, "schema": { "type": "string", "description": "Asset UUID", "format": "uuid", "example": "757400f8-d360-11e9-bb65-2a2ae2dbcce6" } }, { "name": "name", "description": "Name of the metric types: \n- `equinix.fabric.connection.bandwidth_rx.usage`\n- `equinix.fabric.connection.bandwidth_tx.usage`\n- `equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count`\n- `equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count`\n- `equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count`\n- `equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count`\n- `equinix.fabric.connection.byte_rx.count`\n- `equinix.fabric.connection.byte_tx.count`\n- `equinix.fabric.connection.bandwidth_rx.usage_summary`\n- `equinix.fabric.connection.bandwidth_tx.usage_summary`\n- `equinix.fabric.port.bandwidth_rx.usage`\n- `equinix.fabric.port.bandwidth_tx.usage`\n- `equinix.fabric.port.packets_dropped_rx.count`\n- `equinix.fabric.port.packets_dropped_tx.count`\n- `equinix.fabric.port.packets_erred_rx.count`\n- `equinix.fabric.port.packets_erred_tx.count`\n- `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.latency`\n- `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg`\n", "required": true, "schema": { "pattern": "^equinix\\.fabric\\.(connection|port|metro)\\..+", "type": "string", "description": "Name of the metric types: \n- `equinix.fabric.connection.bandwidth_rx.usage`\n- `equinix.fabric.connection.bandwidth_tx.usage`\n- `equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count`\n- `equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count`\n- `equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count`\n- `equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count`\n- `equinix.fabric.connection.byte_rx.count`\n- `equinix.fabric.connection.byte_tx.count`\n- `equinix.fabric.connection.bandwidth_rx.usage_summary`\n- `equinix.fabric.connection.bandwidth_tx.usage_summary`\n- `equinix.fabric.port.bandwidth_rx.usage`\n- `equinix.fabric.port.bandwidth_tx.usage`\n- `equinix.fabric.port.packets_dropped_rx.count`\n- `equinix.fabric.port.packets_dropped_tx.count`\n- `equinix.fabric.port.packets_erred_rx.count`\n- `equinix.fabric.port.packets_erred_tx.count`\n- `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.latency`\n- `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg`\n" } }, { "name": "fromDateTime", "description": "Start date and time", "required": false, "schema": { "type": "string", "description": "Start date and time", "format": "date-time", "example": "2024-07-11T18:06:21.000Z" } }, { "name": "toDateTime", "description": "End date and time", "required": false, "schema": { "type": "string", "description": "End date and time", "format": "date-time", "example": "2024-07-11T18:06:21.000Z" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "type": "integer", "description": "Pagination offset", "default": 0, "example": 0 } }, { "name": "limit", "description": "Pagination limit", "required": false, "schema": { "type": "integer", "description": "Pagination limit", "default": 20, "example": 20 } } ], "result": { "name": "fabric_getMetricByAssetIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getMetricByAssetIdResult" } }, "x-mcp-annotations": { "title": "Get Metrics by Asset Id (Deprecated)", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getMetricByName", "summary": "Get Metrics by Name", "description": "This API provides capability to retrieve Metrics by specific wildcard metric types\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Metrics" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "name", "description": "Name of the metric types with wildcard: \n- `equinix.fabric.metro.*.latency`\n- `equinix.fabric.metro.*.jitter_avg`\n", "required": true, "schema": { "pattern": "^equinix\\.fabric\\.metro\\.\\*\\..+", "type": "string", "description": "Name of the metric types with wildcard: \n- `equinix.fabric.metro.*.latency`\n- `equinix.fabric.metro.*.jitter_avg`\n" } }, { "name": "value", "description": "Which value to retrieve", "required": true, "schema": { "type": "string", "description": "Which value to retrieve", "example": "last" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "type": "integer", "description": "Pagination offset", "default": 0, "example": 0 } }, { "name": "limit", "description": "Pagination limit", "required": false, "schema": { "type": "integer", "description": "Pagination limit", "default": 20, "example": 20 } } ], "result": { "name": "fabric_getMetricByNameResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_cc295fc2" } }, "x-fastmcp-top-level-schema": "GetMetricsByNameResponse" } }, "x-mcp-annotations": { "title": "Get Metrics by Name", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getMetroByCode", "summary": "Get Metro by Code", "description": "GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Metros" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "metroCode", "description": "Metro Code", "required": true, "schema": { "type": "string", "description": "Metro Code" } } ], "result": { "name": "fabric_getMetroByCodeResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "href": { "type": "string", "description": "The Canonical URL at which the resource resides." }, "type": { "type": "string", "description": "Indicator of a Fabric Metro" }, "code": { "type": "string", "description": "Code Assigned to an Equinix IBX data center in a specified metropolitan area." }, "region": { "type": "string", "description": "Board geographic area in which the data center is located" }, "name": { "type": "string", "description": "Name of the region in which the data center is located." }, "country": { "type": "string", "description": "Country code in which the data center is located." }, "equinixAsn": { "type": "integer", "description": "Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.", "format": "int64" }, "localVCBandwidthMax": { "type": "integer", "description": "This field holds Max Connection speed with in the metro", "format": "int64" }, "geoCoordinates": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude of a Fabric Metro", "format": "double" }, "longitude": { "type": "number", "description": "Longitude of a Fabric Metro", "format": "double" } }, "description": "Geographic location data of Fabric Metro" }, "connectedMetros": { "$ref": "#/components/schemas/ConnectedMetros" }, "services": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of Service" } }, "description": "Arrays of objects containing type of services supported in the specified metros" } }, "geoScopes": { "type": "array", "items": { "enum": [ "CANADA", "CONUS", "JAPAN", "UK", "AUSTRALIA", "BRAZIL", "SWITZERLAND", "EU" ], "type": "string", "description": "Geographic boundary types" }, "description": "List of supported geographic boundaries of a Fabric Metro." }, "geoZones": { "$ref": "#/components/schemas/GeoZones" } }, "description": "GET Metros retrieves all Equinix® Fabric™ metros, as well as latency data for each location.This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.", "x-fastmcp-top-level-schema": "Metro" } }, "x-mcp-annotations": { "title": "Get Metro by Code", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getMetros", "summary": "Get Metros", "description": "GET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for each location\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Metros" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "presence", "description": "Presence", "required": false, "schema": { "enum": [ "MY_PORTS" ], "type": "string", "description": "Presence" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getMetrosResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "The Canonical URL at which the resource resides." }, "type": { "type": "string", "description": "Indicator of a Fabric Metro" }, "code": { "type": "string", "description": "Code Assigned to an Equinix IBX data center in a specified metropolitan area." }, "region": { "type": "string", "description": "Board geographic area in which the data center is located" }, "name": { "type": "string", "description": "Name of the region in which the data center is located." }, "country": { "type": "string", "description": "Country code in which the data center is located." }, "equinixAsn": { "type": "integer", "description": "Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.", "format": "int64" }, "localVCBandwidthMax": { "type": "integer", "description": "This field holds Max Connection speed with in the metro", "format": "int64" }, "geoCoordinates": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude of a Fabric Metro", "format": "double" }, "longitude": { "type": "number", "description": "Longitude of a Fabric Metro", "format": "double" } }, "description": "Geographic location data of Fabric Metro" }, "connectedMetros": { "$ref": "#/components/schemas/ConnectedMetros" }, "services": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of Service" } }, "description": "Arrays of objects containing type of services supported in the specified metros" } }, "geoScopes": { "type": "array", "items": { "enum": [ "CANADA", "CONUS", "JAPAN", "UK", "AUSTRALIA", "BRAZIL", "SWITZERLAND", "EU" ], "type": "string", "description": "Geographic boundary types" }, "description": "List of supported geographic boundaries of a Fabric Metro." }, "geoZones": { "$ref": "#/components/schemas/GeoZones" } }, "description": "GET Metros retrieves all Equinix® Fabric™ metros, as well as latency data for each location.This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes." }, "description": "List of Fabric Metros." } }, "description": "GET Metros retrieves all Equinix® Fabric™ metros, as well as latency data for each location.This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.", "x-fastmcp-top-level-schema": "MetroResponse" } }, "x-mcp-annotations": { "title": "Get Metros", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getNetworkByUuid", "summary": "Get Network By ID", "description": "This API provides capability to retrieve user's Fabric Network\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "networkId", "description": "Network UUID", "required": true, "schema": { "type": "string", "description": "Network UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getNetworkByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createNetworkResult_32127b47" } }, "x-mcp-annotations": { "title": "Get Network By ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getNetworkChangeByUuid", "summary": "Get Change By ID", "description": "This API provides capability to retrieve user's Fabric Network Change\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "networkId", "description": "Network UUID", "required": true, "schema": { "type": "string", "description": "Network UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "changeId", "description": "Network Change UUID", "required": true, "schema": { "type": "string", "description": "Network Change UUID", "format": "uuid", "example": "6d500177-9404-41f2-99e8-2bf1a84d8db5" } } ], "result": { "name": "fabric_getNetworkChangeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "href": { "type": "string", "description": "Network URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9" }, "uuid": { "type": "string", "description": "Uniquely identifies a change", "format": "uuid", "example": "4b17da68-3d6b-436d-9c8f-2105f3b950d9" }, "type": { "enum": [ "NETWORK_CREATION", "NETWORK_UPDATE", "NETWORK_DELETION" ], "type": "string", "description": "Type of change", "example": "NETWORK_CREATION" }, "status": { "enum": [ "APPROVED", "COMPLETED", "FAILED", "REJECTED", "REQUESTED", "SUBMITTED_FOR_APPROVAL" ], "type": "string", "description": "Current outcome of the change flow", "example": "COMPLETED" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "data": { "$ref": "#/components/schemas/Data_adf00330" } }, "description": "Current state of latest network change", "x-fastmcp-top-level-schema": "NetworkChange" } }, "x-mcp-annotations": { "title": "Get Change By ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getNetworkChanges", "summary": "Get Network Changes", "description": "The API provides capability to get list of user's Fabric Network changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "networkId", "description": "Network UUID", "required": true, "schema": { "type": "string", "description": "Network UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getNetworkChangesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Network URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9" }, "uuid": { "type": "string", "description": "Uniquely identifies a change", "format": "uuid", "example": "4b17da68-3d6b-436d-9c8f-2105f3b950d9" }, "type": { "enum": [ "NETWORK_CREATION", "NETWORK_UPDATE", "NETWORK_DELETION" ], "type": "string", "description": "Type of change", "example": "NETWORK_CREATION" }, "status": { "enum": [ "APPROVED", "COMPLETED", "FAILED", "REJECTED", "REQUESTED", "SUBMITTED_FOR_APPROVAL" ], "type": "string", "description": "Current outcome of the change flow", "example": "COMPLETED" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "data": { "$ref": "#/components/schemas/Data_adf00330" } }, "description": "Current state of latest network change" } } }, "description": "List of network changes", "x-fastmcp-top-level-schema": "NetworkChangeResponse" } }, "x-mcp-annotations": { "title": "Get Network Changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getOpticalConnectByUuid", "summary": "Get Optical Metro Connect Service", "description": "Get a single Optical Metro Connect by UUID.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Optical Metro Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "opticalConnectId", "description": "Unique identifier of an Optical Connect.", "required": true, "schema": { "type": "string", "description": "Unique identifier of an Optical Connect.", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getOpticalConnectByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createOpticalConnectResult" } }, "x-mcp-annotations": { "title": "Get Optical Metro Connect Service", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getPortByUuid", "summary": "Get Port by ID", "description": "Get Port by ID returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "portId", "description": "Port UUID", "required": true, "schema": { "type": "string", "description": "Port UUID", "format": "uuid" } } ], "result": { "name": "fabric_getPortByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createPortResult" } }, "x-mcp-annotations": { "title": "Get Port by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getPortPackages", "summary": "List Port Packages", "description": "Get All Port Packages returns details of all available port packages for the specified user credentials\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Port Packages" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [], "result": { "name": "fabric_getPortPackagesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "type", "code" ], "type": "object", "properties": { "href": { "type": "string", "description": "Port Package URI" }, "type": { "enum": [ "PORT_PACKAGE" ], "type": "string", "description": "Port Package Type" }, "code": { "type": "string", "description": "Port Package code" }, "vcBandwidthMax": { "type": "integer", "description": "Maximum virtual connection bandwidth in Mbps" }, "vcRemoteSupported": { "type": "boolean", "description": "Indicates if remote virtual connections are supported" }, "supportedServiceTypes": { "type": "array", "items": { "enum": [ "MSP" ], "type": "string", "description": "Port Package Service Type" }, "description": "List of supported service types" }, "supportedSourceTypes": { "type": "array", "items": { "enum": [ "COLO", "REMOTE", "BMMR" ], "type": "string", "description": "Port Package Source Type" }, "description": "List of supported source types" }, "supportedMetros": { "type": "array", "items": { "type": "string" }, "description": "List of supported metros" } }, "description": "Port Package details" }, "description": "List of Port Packages" } }, "description": "Port Packages response", "x-fastmcp-top-level-schema": "AllPortPackagesResponse" } }, "x-mcp-annotations": { "title": "List Port Packages", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getPortStatsByPortUuid", "summary": "Get Stats by ID (DEPRECATED)", "description": "Deprecated: this operation may be removed. Prefer a non-deprecated alternative where one exists.\n\nThis API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.**(DEPRECATED)**\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Statistics" }, { "name": "deprecated" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "portId", "description": "Port UUID", "required": true, "schema": { "type": "string", "description": "Port UUID", "format": "uuid" } }, { "name": "startDateTime", "description": "startDateTime", "required": true, "schema": { "type": "string", "description": "startDateTime", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, { "name": "endDateTime", "description": "endDateTime", "required": true, "schema": { "type": "string", "description": "endDateTime", "format": "date-time", "example": "2020-11-10T07:00:00Z" } } ], "result": { "name": "fabric_getPortStatsByPortUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getConnectionStatsByPortUuidResult" } }, "x-mcp-annotations": { "title": "Get Stats by ID (DEPRECATED)", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getPorts", "summary": "Get All Ports", "description": "Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "name", "description": "port name to be provided if specific port(s) to be retrieved", "required": false, "schema": { "type": "string", "description": "port name to be provided if specific port(s) to be retrieved" } } ], "result": { "name": "fabric_getPortsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getPortsResult" } }, "x-mcp-annotations": { "title": "Get All Ports", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationByUuid", "summary": "Get Aggregation", "description": "This API provides capability to view a Route Aggregation by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } } ], "result": { "name": "fabric_getRouteAggregationByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationResult" } }, "x-mcp-annotations": { "title": "Get Aggregation", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationChangeByUuid", "summary": "Get Change By ID", "description": "This API provides capability to retrieve a specific Route Aggregation's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "changeId", "description": "Route Aggregations Change UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations Change UUID", "format": "uuid", "example": "6d500177-9404-41f2-99e8-2bf1a84d8db5" } } ], "result": { "name": "fabric_getRouteAggregationChangeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_28881cd4" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_f02cb8b3" } }, "description": "Current state of latest Route Aggregation change", "x-fastmcp-top-level-schema": "RouteAggregationChangeData" } }, "x-mcp-annotations": { "title": "Get Change By ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationChanges", "summary": "Get Route Aggregation Changes", "description": "This API provides capability to retrieve all of a Route Aggregation's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getRouteAggregationChangesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_28881cd4" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_f02cb8b3" } }, "description": "Current state of latest Route Aggregation change" } } }, "description": "List of Route Aggregation changes", "x-fastmcp-top-level-schema": "RouteAggregationChangeDataResponse" } }, "x-mcp-annotations": { "title": "Get Route Aggregation Changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationConnections", "summary": "Get Route Aggregation Connections", "description": "This API provides capability to view all Connections using the Route Aggregation\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } } ], "result": { "name": "fabric_getRouteAggregationConnectionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f" }, "type": { "enum": [ "EVPL_VC", "EPL_VC", "EC_VC", "IP_VC", "ACCESS_EPL_VC", "EIA_VC", "EVPLAN_VC", "EPLAN_VC", "EVPTREE_VC", "EPTREE_VC", "IPWAN_VC", "IA_VC", "MC_VC", "IX_VC", "GW_VC", "IPX_VC" ], "type": "string", "description": "Connection type" }, "uuid": { "type": "string", "description": "Route Aggregation identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "name": { "type": "string", "example": "connection-1" } } }, "description": "List of Connections using a Route Aggregation" } }, "x-fastmcp-top-level-schema": "GetRouteAggregationGetConnectionsResponse" } }, "x-mcp-annotations": { "title": "Get Route Aggregation Connections", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationRuleByUuid", "summary": "Get Route Aggregation Rule by ID", "description": "This API provides capability to view a Route Aggregation Rule by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeAggregationRuleId", "description": "Route Aggregation Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregation Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } } ], "result": { "name": "fabric_getRouteAggregationRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationRuleResult" } }, "x-mcp-annotations": { "title": "Get Route Aggregation Rule by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationRuleChangeByUuid", "summary": "Get Change By ID", "description": "This API provides capability to retrieve a specific Route Aggregation Rule's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeAggregationRuleId", "description": "Route Aggregation Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregation Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "changeId", "description": "Route Aggregation Rule Change UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregation Rule Change UUID", "format": "uuid", "example": "6d500177-9404-41f2-99e8-2bf1a84d8db5" } } ], "result": { "name": "fabric_getRouteAggregationRuleChangeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_47ab42a6" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "data": { "$ref": "#/components/schemas/Data_92d21180" } }, "description": "Current state of latest Route Aggregation Rules change", "x-fastmcp-top-level-schema": "RouteAggregationRulesChangeData" } }, "x-mcp-annotations": { "title": "Get Change By ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationRuleChanges", "summary": "Get Route Aggregation Rule Changes", "description": "This API provides capability to retrieve all of a Route Aggregation Rule's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeAggregationRuleId", "description": "Route Aggregation Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregation Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getRouteAggregationRuleChangesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_47ab42a6" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "data": { "$ref": "#/components/schemas/Data_92d21180" } }, "description": "Current state of latest Route Aggregation Rules change" } } }, "description": "List of Route Aggregation Rule changes", "x-fastmcp-top-level-schema": "RouteAggregationRulesChangeDataResponse" } }, "x-mcp-annotations": { "title": "Get Route Aggregation Rule Changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteAggregationRules", "summary": "Get Route Aggregation Rules", "description": "This API provides capability to get all Route Aggregations Rules for Fabric\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getRouteAggregationRulesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationRulesInBulkResult" } }, "x-mcp-annotations": { "title": "Get Route Aggregation Rules", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterByUuid", "summary": "Get Route Filter by ID", "description": "This API provides capability to view a Route Filter by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } } ], "result": { "name": "fabric_getRouteFilterByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterResult" } }, "x-mcp-annotations": { "title": "Get Route Filter by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterChangeByUuid", "summary": "Get Change By ID", "description": "This API provides capability to retrieve a specific Route Filter's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "changeId", "description": "Route Filters Change UUID", "required": true, "schema": { "type": "string", "description": "Route Filters Change UUID", "format": "uuid", "example": "6d500177-9404-41f2-99e8-2bf1a84d8db5" } } ], "result": { "name": "fabric_getRouteFilterChangeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_2554fe61" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by user key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by user key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_d67405e5" } }, "description": "Current state of latest route filter change", "x-fastmcp-top-level-schema": "RouteFilterChangeData" } }, "x-mcp-annotations": { "title": "Get Change By ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterChanges", "summary": "Get Route Filter Changes", "description": "This API provides capability to retrieve all of a Route Filter's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getRouteFilterChangesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_2554fe61" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by user key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by user key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_d67405e5" } }, "description": "Current state of latest route filter change" } } }, "description": "List of route filter changes", "x-fastmcp-top-level-schema": "RouteFilterChangeDataResponse" } }, "x-mcp-annotations": { "title": "Get Route Filter Changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterConnections", "summary": "Get All Connections on Route Filter", "description": "This API provides capability to view all Connections using the Route Filter\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } } ], "result": { "name": "fabric_getRouteFilterConnectionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f" }, "type": { "enum": [ "EVPL_VC", "EPL_VC", "EC_VC", "IP_VC", "ACCESS_EPL_VC", "EIA_VC", "EVPLAN_VC", "EPLAN_VC", "EVPTREE_VC", "EPTREE_VC", "IPWAN_VC", "IA_VC", "MC_VC", "IX_VC", "GW_VC", "IPX_VC" ], "type": "string", "description": "Connection type" }, "uuid": { "type": "string", "description": "Route filter identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "name": { "type": "string", "example": "connection-1" } } }, "description": "List of Connections using a Route Filter" } }, "x-fastmcp-top-level-schema": "GetRouteFilterGetConnectionsResponse" } }, "x-mcp-annotations": { "title": "Get All Connections on Route Filter", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterRuleByUuid", "summary": "Get Route Filter Rule by ID", "description": "This API provides capability to view a Route Filter Rule by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeFilterRuleId", "description": "Route Filter Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Filter Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } } ], "result": { "name": "fabric_getRouteFilterRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterRuleResult" } }, "x-mcp-annotations": { "title": "Get Route Filter Rule by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterRuleChangeByUuid", "summary": "Get Change By ID", "description": "This API provides capability to retrieve a specific Route Filter Rule's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeFilterRuleId", "description": "Route Filter Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Filter Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "changeId", "description": "Route Filter Rule Change UUID", "required": true, "schema": { "type": "string", "description": "Route Filter Rule Change UUID", "format": "uuid", "example": "6d500177-9404-41f2-99e8-2bf1a84d8db5" } } ], "result": { "name": "fabric_getRouteFilterRuleChangeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_979fb309" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "data": { "$ref": "#/components/schemas/Data_adafd426" } }, "description": "Current state of latest route filter rules change", "x-fastmcp-top-level-schema": "RouteFilterRulesChangeData" } }, "x-mcp-annotations": { "title": "Get Change By ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterRuleChanges", "summary": "Get Route Filter Rule Changes", "description": "This API provides capability to retrieve all of a Route Filter Rule's Changes\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeFilterRuleId", "description": "Route Filter Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Filter Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getRouteFilterRuleChangesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Change_979fb309" } ], "properties": { "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdBy": { "type": "string", "description": "Created by User Key" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Updated by User Key" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time" }, "data": { "$ref": "#/components/schemas/Data_adafd426" } }, "description": "Current state of latest route filter rules change" } } }, "description": "List of route filter rule changes", "x-fastmcp-top-level-schema": "RouteFilterRulesChangeDataResponse" } }, "x-mcp-annotations": { "title": "Get Route Filter Rule Changes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getRouteFilterRules", "summary": "Get Route Filter Rules", "description": "This API provides capability to get all Route Filters Rules for Fabric\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getRouteFilterRulesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterRulesInBulkResult" } }, "x-mcp-annotations": { "title": "Get Route Filter Rules", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getServiceProfileByUuid", "summary": "Get Service Profile", "description": "Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } }, { "name": "viewPoint", "description": "flips view between buyer and seller representation", "required": false, "schema": { "enum": [ "aSide", "zSide" ], "type": "string", "default": "aSide", "description": "flips view between buyer and seller representation" } } ], "result": { "name": "fabric_getServiceProfileByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceProfileResult" } }, "x-mcp-annotations": { "title": "Get Service Profile", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getServiceProfileEnvironmentsByUuid", "summary": "Get Service Profile Environments", "description": "Get service profile provider environments by UUID Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getServiceProfileEnvironmentsByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsItem" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "description": "Service Profile Provider Environments", "x-fastmcp-top-level-schema": "ProviderEnvironments" } }, "x-mcp-annotations": { "title": "Get Service Profile Environments", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getServiceProfileMetrosByUuid", "summary": "Get Service Profile Metros", "description": "Get service profile metros by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getServiceProfileMetrosByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MetrosItem" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "description": "Service Profile Metros", "x-fastmcp-top-level-schema": "ServiceMetros" } }, "x-mcp-annotations": { "title": "Get Service Profile Metros", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getServiceTokenByUuid", "summary": "Get Service Token by ID", "description": "Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Tokens" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceTokenId", "description": "Service Token UUID", "required": true, "schema": { "type": "string", "description": "Service Token UUID", "format": "uuid" } } ], "result": { "name": "fabric_getServiceTokenByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceTokenResult" } }, "x-mcp-annotations": { "title": "Get Service Token by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getServiceTokens", "summary": "Get Service Tokens", "description": "Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Tokens" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "offset", "required": false, "schema": { "type": "number", "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "number", "description": "number of records to fetch" } } ], "result": { "name": "fabric_getServiceTokensResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getServiceTokensResult" } }, "x-mcp-annotations": { "title": "Get Service Tokens", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStatus", "summary": "Get Service Status", "description": "Retrieves the operational health status of all Equinix Fabric services, enabling customers to monitor service availability and detect potential disruptions across regions where they have a presence. Supports an optional query parameter to filter results by customer\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Health" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [], "result": { "name": "fabric_getStatusResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "href": { "type": "string", "description": "The Canonical URL at which the resource resides." }, "version": { "type": "string", "description": "Indicator of a version" }, "release": { "type": "string", "description": "release details." }, "state": { "type": "string", "description": "status of a service" }, "apiServices": { "type": "object", "properties": { "route": { "type": "string", "description": "service routes" }, "status": { "type": "string", "description": "service status" }, "changedDateTime": { "type": "string", "description": "service status change date" } }, "description": "Available services details" } }, "description": "GET Services Health", "x-fastmcp-top-level-schema": "HealthResponse" } }, "x-mcp-annotations": { "title": "Get Service Status", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreamAlertRuleByUuid", "summary": "Get Stream Alert Rule", "description": "This API provides capability to get user's stream alert rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Alert Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "alertRuleId", "description": "Stream Alert Rule UUID", "required": true, "schema": { "type": "string", "description": "Stream Alert Rule UUID", "format": "uuid", "example": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15" } } ], "result": { "name": "fabric_getStreamAlertRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamAlertRulesResult" } }, "x-mcp-annotations": { "title": "Get Stream Alert Rule", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreamAlertRules", "summary": "Get Stream Alert Rules", "description": "This API provides capability to retrieve stream alert rules\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Alert Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getStreamAlertRulesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream Alert Rule URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "METRIC_ALERT" ], "type": "string", "description": "Stream subscription type" }, "name": { "type": "string", "description": "Customer-provided stream alert rule name" }, "description": { "type": "string", "description": "Customer-provided stream alert rule description" }, "state": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string", "description": "Steam subscription provision state" }, "enabled": { "type": "boolean", "description": "Stream alert rule enabled status", "default": true }, "metricSelector": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "example": "equinix.fabric.metro.sv_da.latency" }, "description": "Stream alert rule filtered by metric name" } } }, "resourceSelector": { "$ref": "#/components/schemas/ResourceSelector_30b32894" }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod_3af096e5" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Stream object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "GetAllStreamAlertRuleResponse" } }, "x-mcp-annotations": { "title": "Get Stream Alert Rules", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreamAssetByUuid", "summary": "Get Asset", "description": "This API provides capability to get user's assets attached to a stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "assetId", "description": "Stream Asset UUID", "required": true, "schema": { "type": "string", "description": "Stream Asset UUID", "format": "uuid", "example": "757400f8-d360-11e9-bb65-2a2ae2dbcce6" } }, { "name": "asset", "description": "asset", "required": true, "schema": { "enum": [ "ports", "connections", "routers", "metros", "organizations", "projects", "companyProfiles" ], "type": "string", "description": "asset" } }, { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } } ], "result": { "name": "fabric_getStreamAssetByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteStreamAssetByUuidResult" } }, "x-mcp-annotations": { "title": "Get Asset", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreamByUuid", "summary": "Get Stream", "description": "This API provides capability to get user's stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } } ], "result": { "name": "fabric_getStreamByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamsResult" } }, "x-mcp-annotations": { "title": "Get Stream", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreamDevice", "summary": "Get Network Edge Device", "description": "This API provides capability to get a Network Edge Device and its interfaces attached to a stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "deviceId", "description": "Network Edge Device UUID", "required": true, "schema": { "type": "string", "description": "Network Edge Device UUID", "format": "uuid", "example": "8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d" } } ], "result": { "name": "fabric_getStreamDeviceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteStreamAssetByUuidResult" } }, "x-mcp-annotations": { "title": "Get Network Edge Device", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreamSubscriptionByUuid", "summary": "Get Subscription", "description": "This API provides capability to delete user's get Stream Subscriptions\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "subscriptionId", "description": "Stream Subscription UUID", "required": true, "schema": { "type": "string", "description": "Stream Subscription UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getStreamSubscriptionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamSubscriptionsResult" } }, "x-mcp-annotations": { "title": "Get Subscription", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreamSubscriptions", "summary": "Get Subscriptions", "description": "This API provides capability to retrieve stream subscriptions\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getStreamSubscriptionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_4194e588" } }, "x-fastmcp-top-level-schema": "GetAllStreamSubscriptionResponse" } }, "x-mcp-annotations": { "title": "Get Subscriptions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getStreams", "summary": "Get Streams", "description": "This API provides capability to retrieve streams\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getStreamsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_e2b21d81" } }, "x-fastmcp-top-level-schema": "GetAllStreamResponse" } }, "x-mcp-annotations": { "title": "Get Streams", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getSubscriptionById", "summary": "Get Subscription", "description": "The API provides capability to get subscription\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Marketplace Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "subscriptionId", "description": "Subscription Id", "required": true, "schema": { "type": "string", "description": "Subscription Id", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getSubscriptionByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "state", "marketplace", "entitlements" ], "type": "object", "properties": { "href": { "type": "string", "description": "Subscription URL", "format": "uri" }, "uuid": { "type": "string", "description": "Unique identifier of the Subscription", "format": "uuid" }, "state": { "enum": [ "ACTIVE", "EXPIRED", "CANCELLED", "GRACE_PERIOD" ], "type": "string", "description": "Subscription State" }, "marketplace": { "enum": [ "AWS", "GCP", "AZURE", "REDHAT" ], "type": "string", "description": "Marketplace Type" }, "offerType": { "enum": [ "PUBLIC", "PRIVATE_OFFER" ], "type": "string", "description": "Marketplace Offer Type" }, "isAutoRenew": { "type": "boolean", "description": "Is Auto Renewal Enabled", "example": true }, "offerId": { "type": "string", "description": "Marketplace Offer Id" }, "trial": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Free Trial Enabled" }, "expiryDateTime": { "type": "string", "description": "Free Trial Expiry Date", "format": "date-time" } }, "description": "Free Trial Subscription" }, "metroCodes": { "type": "array", "items": { "type": "string" }, "description": "List of available metro" }, "entitlements": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Subscription Entitlement Id", "format": "uuid" }, "quantityEntitled": { "minimum": 0.0, "type": "integer", "description": "Quantity entitled for the subscription" }, "quantityConsumed": { "minimum": 0.0, "type": "integer", "description": "Quantity consumed from the entitlement" }, "quantityAvailable": { "minimum": 0.0, "type": "integer", "description": "Quantity available from the entitlement" }, "asset": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the subscription asset ( XF_ROUTER ,IP_VC, IPWAN_VC )" }, "package": { "type": "object", "properties": { "code": { "type": "string", "description": "Cloud Router package code" } }, "description": "Cloud Router Package Type" }, "bandwidth": { "type": "integer", "description": "Bandwidth of the asset in Mbps" } }, "description": "Asset information" } }, "description": "Subscription entitlement" }, "description": "List of entitlements associated with the subscription" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Subscription Response", "x-fastmcp-top-level-schema": "SubscriptionResponse" } }, "x-mcp-annotations": { "title": "Get Subscription", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getTagByUuid", "summary": "Get Tag", "description": "Get Tag by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Tags" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the Tag", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the Tag" } } ], "result": { "name": "fabric_getTagByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createTagResult" } }, "x-mcp-annotations": { "title": "Get Tag", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getTags", "summary": "Get Tags", "description": "Get all tags attached to a company profile Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "companyProfileId", "description": "Company Profile UUID", "required": true, "schema": { "type": "string", "description": "Company Profile UUID" } } ], "result": { "name": "fabric_getTagsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getTagsResult" } }, "x-mcp-annotations": { "title": "Get Tags", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getTimeServicesById", "summary": "Get Time Service by ID", "description": "The API provides capability to get Precision Time Service details\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Precision Time Service UUID", "required": true, "schema": { "type": "string", "description": "Precision Time Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getTimeServicesByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PrecisionTimeServiceResponse" } }, "x-mcp-annotations": { "title": "Get Time Service by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getTimeServicesConnectionsByServiceId", "summary": "Get Connection Links", "description": "The API provides capability to get prevision timing service's details\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Precision Time Service UUID", "required": true, "schema": { "type": "string", "description": "Precision Time Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } } ], "result": { "name": "fabric_getTimeServicesConnectionsByServiceIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "precisionTimeServiceConnectionResponse", "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "example": "https://api.equinix.com/fabric/v4/timeServices/92dc376a-a932-43aa-a6a2-c806dedbd784/connections" }, "type": { "enum": [ "EVPL_VC" ], "type": "string" }, "uuid": { "type": "string", "format": "uuid" } } }, "description": "Data returned from the API call" } }, "description": "EPT service instance's L2 connections", "x-fastmcp-top-level-schema": "precisionTimeServiceConnectionsResponse" } }, "x-mcp-annotations": { "title": "Get Connection Links", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getTimeServicesPackageByCode", "summary": "Get Package By Code", "description": "The API provides capability to get timing service's package by code\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Packages" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "packageCode", "description": "Package Code", "required": true, "schema": { "enum": [ "NTP_STANDARD", "NTP_ENTERPRISE", "PTP_STANDARD", "PTP_ENTERPRISE" ], "type": "string", "description": "Package Code" } } ], "result": { "name": "fabric_getTimeServicesPackageByCodeResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "precisionTimePackageRespose", "required": [ "type", "code", "bandwidth" ], "type": "object", "properties": { "href": { "type": "string", "format": "uri" }, "type": { "enum": [ "TIME_SERVICE_PACKAGE" ], "type": "string" }, "code": { "enum": [ "NTP_STANDARD", "NTP_ENTERPRISE", "PTP_STANDARD", "PTP_ENTERPRISE" ], "type": "string" }, "bandwidth": { "type": "integer", "description": "Connection bandwidth in Mbps.", "example": 10 }, "clientsPerSecondMax": { "minimum": 0.0, "type": "integer", "description": "Max. number of clients that can be synchronized per second at a packet rate of 1 per second.", "example": 100 }, "redundancySupported": { "type": "boolean", "description": "Is Redundant virtual connection supported for the package code.", "example": false }, "multiSubnetSupported": { "type": "boolean", "description": "Is Multiple subnet supported for the package code.", "example": true }, "accuracySlaUnit": { "type": "string", "description": "Accuracy SLA unit.", "example": "microseconds" }, "accuracySla": { "type": "integer", "description": "Accuracy SLA for the package code, -1 value denotes the accuracySla is not published.", "example": 50 }, "accuracySlaMin": { "minimum": 1.0, "type": "integer", "description": "Typical minimum Accuracy for the package code.", "example": 1 }, "accuracySlaMax": { "minimum": 1.0, "type": "integer", "description": "Typical maximum Accuracy for the package code.", "example": 10 }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "EPT Service Package Information", "example": { "href": "https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD", "type": "TIME_SERVICE_PACKAGE", "code": "NTP_STANDARD", "bandwidth": 10, "accuracySlaUnit": "microseconds", "accuracySla": 50, "accuracySlaMin": 1, "accuracySlaMax": 10, "clientsPerSecondMax": 100, "redundancySupported": true, "multiSubnetSupported": true, "changelog": { "createdDateTime": "2023-05-16T07:50:49.749Z", "updatedDateTime": "2023-05-17T07:50:49.749Z" } }, "x-fastmcp-top-level-schema": "precisionTimePackageResponse" } }, "x-mcp-annotations": { "title": "Get Package By Code", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getTimeServicesPackages", "summary": "Get Packages", "description": "The API provides capability to get timing service's packages\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Packages" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [], "result": { "name": "fabric_getTimeServicesPackagesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "precisionTimeServicePackagesResponse", "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "title": "precisionTimePackageRespose", "required": [ "type", "code", "bandwidth" ], "type": "object", "properties": { "href": { "type": "string", "format": "uri" }, "type": { "enum": [ "TIME_SERVICE_PACKAGE" ], "type": "string" }, "code": { "enum": [ "NTP_STANDARD", "NTP_ENTERPRISE", "PTP_STANDARD", "PTP_ENTERPRISE" ], "type": "string" }, "bandwidth": { "type": "integer", "description": "Connection bandwidth in Mbps.", "example": 10 }, "clientsPerSecondMax": { "minimum": 0.0, "type": "integer", "description": "Max. number of clients that can be synchronized per second at a packet rate of 1 per second.", "example": 100 }, "redundancySupported": { "type": "boolean", "description": "Is Redundant virtual connection supported for the package code.", "example": false }, "multiSubnetSupported": { "type": "boolean", "description": "Is Multiple subnet supported for the package code.", "example": true }, "accuracySlaUnit": { "type": "string", "description": "Accuracy SLA unit.", "example": "microseconds" }, "accuracySla": { "type": "integer", "description": "Accuracy SLA for the package code, -1 value denotes the accuracySla is not published.", "example": 50 }, "accuracySlaMin": { "minimum": 1.0, "type": "integer", "description": "Typical minimum Accuracy for the package code.", "example": 1 }, "accuracySlaMax": { "minimum": 1.0, "type": "integer", "description": "Typical maximum Accuracy for the package code.", "example": 10 }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "EPT Service Package Information", "example": { "href": "https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD", "type": "TIME_SERVICE_PACKAGE", "code": "NTP_STANDARD", "bandwidth": 10, "accuracySlaUnit": "microseconds", "accuracySla": 50, "accuracySlaMin": 1, "accuracySlaMax": 10, "clientsPerSecondMax": 100, "redundancySupported": true, "multiSubnetSupported": true, "changelog": { "createdDateTime": "2023-05-16T07:50:49.749Z", "updatedDateTime": "2023-05-17T07:50:49.749Z" } } }, "description": "Data returned from the API call" } }, "description": "Precision Packages", "x-fastmcp-top-level-schema": "precisionTimeServicePackagesResponse" } }, "x-mcp-annotations": { "title": "Get Packages", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_getVlans", "summary": "Get Vlans", "description": "The API provides capability to retrieve Vlans for a Port\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "portUuid", "description": "Port UUID", "required": true, "schema": { "type": "string", "description": "Port UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } } ], "result": { "name": "fabric_getVlansResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "LinkProtocol URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned network identifier", "format": "uuid", "example": "92dc376a-a932-43aa-a6a2-c806dedbd784" }, "state": { "enum": [ "RESERVED", "RELEASED" ], "type": "string", "description": "Network status", "example": "ACTIVE" }, "type": { "enum": [ "UNTAGGED", "DOT1Q", "QINQ", "VXLAN" ], "type": "string", "description": "Type of Link Protocol", "example": "DOT1Q" }, "vlanTag": { "type": "integer", "example": 20 }, "vni": { "type": "integer", "example": 20 }, "vlanTagMin": { "type": "integer", "example": 20 }, "vlanTagMax": { "type": "integer", "example": 200 }, "vlanSTag": { "type": "integer", "example": 20 }, "vlanCTag": { "type": "integer", "example": 20 }, "vlanCTagMin": { "type": "integer", "example": 20 }, "vlanCTagMax": { "type": "integer", "example": 200 }, "subInterface": { "type": "object", "properties": { "name": { "type": "string", "description": "name of subInterface of a port" }, "unit": { "type": "integer", "example": 200 } }, "description": "Sub Interface information" }, "asset": { "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "uri" }, "uuid": { "type": "string", "format": "string", "example": "cd67f685-41b0-1b07-6de0-320a5c00abe" }, "type": { "type": "string", "example": "EVPL_VC" }, "bandwidth": { "type": "integer", "format": "int64", "example": 100 } }, "description": "Connection details of Link Protocol" }, "serviceToken": { "type": "object", "properties": { "href": { "type": "string", "description": "Service Token URI", "format": "uri" }, "uuid": { "type": "string", "format": "uuid", "example": "cd67f685-41b0-1b07-6de0-320a5c00eabe" }, "type": { "type": "string", "example": "TOKEN" }, "bandwidth": { "type": "integer", "format": "int64", "example": 1000 } }, "description": "Service Token details of Link Protocol" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Link Protocol response" } } }, "description": "List of Vlans", "x-fastmcp-top-level-schema": "LinkProtocolGetResponse" } }, "x-mcp-annotations": { "title": "Get Vlans", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_listServiceProfiles", "summary": "List Service Profiles", "description": "The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "offset", "required": false, "schema": { "type": "integer", "example": 1, "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "integer", "example": 10, "description": "number of records to fetch" } }, { "name": "viewPoint", "description": "flips view between buyer and seller representation", "required": false, "schema": { "enum": [ "aSide", "zSide" ], "type": "string", "default": "aSide", "description": "flips view between buyer and seller representation" } } ], "result": { "name": "fabric_listServiceProfilesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_listServiceProfilesResult" } }, "x-mcp-annotations": { "title": "List Service Profiles", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_listTags", "summary": "List Tags", "description": "Get all Tags\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Tags" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Filter by tag type", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by tag type" } }, { "name": "offset", "description": "Offset for pagination", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "description": "Offset for pagination" } }, { "name": "limit", "description": "Limit for pagination", "required": false, "schema": { "maximum": 100.0, "type": "integer", "format": "int32", "default": 20, "description": "Limit for pagination" } } ], "result": { "name": "fabric_listTagsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getTagsResult" } }, "x-mcp-annotations": { "title": "List Tags", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_patchAsnById", "summary": "Update ASN", "description": "Update ASN record\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "ASNs" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "asnId", "description": "UUID of the ASN record", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the ASN record" } }, { "name": "body", "required": true, "schema": { "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "add", "remove", "replace" ], "type": "string", "description": "JSON Patch operation" }, "path": { "type": "string", "description": "JSON Pointer to the field to update", "example": "/ownershipChallengeDetails/signature" }, "value": { "description": "New value for add or replace operations", "example": "MEUCIQCrExampleBase64SignatureValue7h4Yg==" } } } } } ], "result": { "name": "fabric_patchAsnByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAsnResult" } }, "x-mcp-annotations": { "title": "Update ASN", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_patchConnectionRoutingProtocolByUuid", "summary": "Patch Protocol", "description": "This API provides capability to partially update Routing Protocols on a virtual connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "body", "description": "Patch connection routing protocol request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Data_c55f2d51" }, "description": "Patch connection routing protocol request" } } ], "result": { "name": "fabric_patchConnectionRoutingProtocolByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_a1b7bd9c" } }, "x-mcp-annotations": { "title": "Patch Protocol", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_patchEiaService", "summary": "Update Internet Access Service by ID", "description": "Patch Internet Access Service by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Access Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the EIA Service", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the EIA Service" } }, { "name": "body", "description": "Only one replace operation allowed for '/bandwidth' path.", "required": true, "schema": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "required": [ "op", "path" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "Allowed patch operations." }, "path": { "pattern": "^(\\/name|\\/bandwidth|\\/bandwidthCommit|\\/routingProtocol\\/customerRoutes(?:\\[@\\.ipBlock\\.uuid=[A-Fa-f0-9-]+\\])?|\\/order\\/purchaseOrderNumber)$", "type": "string", "description": "Allowed patch paths for Internet Access update.", "example": "/bandwidth" }, "value": { "description": "New value for updated parameter. Required for add and replace." } } }, "description": "Only one replace operation allowed for '/bandwidth' path." } } ], "result": { "name": "fabric_patchEiaServiceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createEiaServiceResult" } }, "x-mcp-annotations": { "title": "Update Internet Access Service by ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_patchIpBlockById", "summary": "Update IP Block by ID", "description": "patch IP Block by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "IP Blocks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "UUID of the IP Block", "required": true, "schema": { "type": "string", "format": "uuid", "description": "UUID of the IP Block" } }, { "name": "body", "required": true, "schema": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "required": [ "op", "path" ], "type": "object", "properties": { "op": { "enum": [ "add", "remove" ], "type": "string", "description": "operation" }, "path": { "type": "string", "description": "path" }, "value": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } }, "description": "new value" } } } } } ], "result": { "name": "fabric_patchIpBlockByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteIpBlockByIdResult" } }, "x-mcp-annotations": { "title": "Update IP Block by ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_patchRouteAggregationByUuid", "summary": "Update Route Aggregation", "description": "This API provides capability to partially update a Route Aggregation\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "body", "description": "Patch Route Aggregations request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Handy shortcut for operation name", "example": "replace" }, "path": { "type": "string", "description": "path to change", "example": "/name" }, "value": { "description": "new value for updated parameter" } }, "description": "Route Aggregation change operation data" }, "description": "Patch Route Aggregations request" } } ], "result": { "name": "fabric_patchRouteAggregationByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationResult" } }, "x-mcp-annotations": { "title": "Update Route Aggregation", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_patchRouteAggregationRuleByUuid", "summary": "Update Route Aggregation Rule", "description": "This API provides capability to partially update a Route Aggregation Rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeAggregationRuleId", "description": "Route Aggregation Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregation Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "body", "description": "Patch Route Aggregations Rule request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Handy shortcut for operation name", "example": "replace" }, "path": { "type": "string", "description": "path to change", "example": "/prefix" }, "value": { "description": "new value for updated parameter" } }, "description": "Route Aggregation Rule change operation data" }, "description": "Patch Route Aggregations Rule request" } } ], "result": { "name": "fabric_patchRouteAggregationRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationRuleResult" } }, "x-mcp-annotations": { "title": "Update Route Aggregation Rule", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_patchRouteFilterByUuid", "summary": "Update Route Filter", "description": "This API provides capability to partially update a Route Filter\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "body", "description": "Patch Route Filters request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Handy shortcut for operation name", "example": "replace" }, "path": { "type": "string", "description": "path to change", "example": "/name" }, "value": { "description": "new value for updated parameter" } }, "description": "Route filter change operation data" }, "description": "Patch Route Filters request" } } ], "result": { "name": "fabric_patchRouteFilterByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterResult" } }, "x-mcp-annotations": { "title": "Update Route Filter", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_patchRouteFilterRuleByUuid", "summary": "Update Route Filter Rule", "description": "This API provides capability to partially update a Route Filter Rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeFilterRuleId", "description": "Route Filter Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Filter Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "body", "description": "Patch Route Filters Rule request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Handy shortcut for operation name", "example": "replace" }, "path": { "type": "string", "description": "path to change", "example": "/prefixMatch" }, "value": { "description": "new value for updated parameter" } }, "description": "Route filter rule change operation data" }, "description": "Patch Route Filters Rule request" } } ], "result": { "name": "fabric_patchRouteFilterRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterRuleResult" } }, "x-mcp-annotations": { "title": "Update Route Filter Rule", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_performCrossConnectAction", "summary": "Cross Connect Actions", "description": "The API provides capability to perform an action on a Cross Connect that is in the PENDING_ACTION state. The applicable action types are listed in the allowedActions of the Cross Connect.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } }, { "name": "type", "description": "Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment.\n", "required": true, "schema": { "$ref": "#/components/schemas/Type_2066d11d" } }, { "name": "data", "description": "Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule is required for XC_DEINSTALL, where liveTrafficConsentProvided, services, notifications and order are applicable.
Not applicable to the other action types.\n", "required": false, "schema": { "type": "object", "properties": { "notes": { "maxItems": 1, "type": "array", "items": { "required": [ "comments" ], "type": "object", "properties": { "parentNote": { "$ref": "#/components/schemas/ParentNote_9dc706ff" }, "comments": { "maxLength": 4000, "type": "string", "description": "Note comments.", "example": "Please proceed" } }, "description": "Note supplied by the customer when responding to an action." }, "description": "Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL." }, "attachments": { "maxItems": 5, "type": "array", "items": { "required": [ "attachmentId" ], "type": "object", "properties": { "attachmentId": { "type": "string", "description": "Attachment Identifier.", "format": "uuid", "example": "a11f485e-3094-42de-8797-0ef19a51df79" } }, "description": "Cross Connect Attachment." }, "description": "Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL." }, "schedule": { "allOf": [ { "required": [ "requestedDateTime" ], "type": "object", "properties": { "type": { "enum": [ "XC_DEINSTALL_SCHEDULE" ], "type": "string", "description": "Schedule type.", "example": "XC_DEINSTALL_SCHEDULE" }, "code": { "enum": [ "STANDARD" ], "type": "string", "description": "Schedule code of the removal. Only STANDARD is supported, and it is applied when the code is omitted.\n", "default": "STANDARD", "example": "STANDARD" }, "requestedDateTime": { "type": "string", "description": "Requested Removal Date and Time.", "format": "date-time", "example": "2026-06-14T17:21:25.586Z" }, "deinstallationDateTime": { "type": "string", "description": "Deinstallation Date and Time.", "format": "date-time", "example": "2026-06-16T17:21:25.586Z" } }, "description": "Cross Connect Deinstallation Schedule." } ], "description": "Removal schedule. Required for XC_DEINSTALL - the requestedDateTime is mandatory and only the STANDARD schedule type is supported.\n" }, "liveTrafficConsentProvided": { "type": "boolean", "description": "Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic.\n", "example": true }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/ServicesItem_c22f48ea" }, "description": "Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall.\n" }, "notifications": { "$ref": "#/components/schemas/Notifications_7885f438" }, "order": { "$ref": "#/components/schemas/Order_cee822fd" } }, "description": "Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule is required for XC_DEINSTALL, where liveTrafficConsentProvided, services, notifications and order are applicable.
Not applicable to the other action types.\n" } } ], "result": { "name": "fabric_performCrossConnectActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getCrossConnectActionByUuidResult" } }, "x-mcp-annotations": { "title": "Cross Connect Actions", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_performLoaAction", "summary": "Create LOA Action", "description": "The API provides capability to perform actions on Loa\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } }, { "name": "type", "description": "Action to perform on the LOA.", "required": true, "schema": { "enum": [ "LOA_ISSUER_AUTHORIZATION", "LOA_REQUESTOR_ACCEPTANCE", "LOA_COPY_LINK", "LOA_SEND_EMAIL_NOTIFICATION", "LOA_CANCEL" ], "type": "string", "description": "Action to perform on the LOA.", "example": "LOA_ISSUER_AUTHORIZATION" } }, { "name": "data", "description": "Action Data.
For LOA_ISSUER_AUTHORIZATION — always required.\n", "required": false, "schema": { "$ref": "#/components/schemas/Data_66916414" } } ], "result": { "name": "fabric_performLoaActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getLoaActionsByUuidResult" } }, "x-mcp-annotations": { "title": "Create LOA Action", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_postConnectionRoutingProtocolBgpActionByUuid", "summary": "Clear/Reset BGP", "description": "This API provides capability to clear/reset Routing Protocols BGP session\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "description": "BGP action type", "required": true, "schema": { "enum": [ "CLEAR_BGPIPV4", "CLEAR_BGPIPV6", "CLEAR_BGPIPV4_INBOUND", "CLEAR_BGPIPV6_INBOUND", "RESET_BGPIPV4", "RESET_BGPIPV6" ], "type": "string", "description": "BGP action type" } } ], "result": { "name": "fabric_postConnectionRoutingProtocolBgpActionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getConnectionRoutingProtocolsBgpActionByUuidResult" } }, "x-mcp-annotations": { "title": "Clear/Reset BGP", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_putServiceProfileByUuid", "summary": "Replace Service Profile", "description": "This API request replaces a service profile definition\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } }, { "name": "If-Match", "description": "conditional request", "required": true, "schema": { "type": "string", "description": "conditional request" } }, { "name": "type", "description": "Service profile type", "required": true, "schema": { "enum": [ "L2_PROFILE", "L3_PROFILE", "IA_PROFILE", "IX_PROFILE", "IC_PROFILE", "LMAAS_PROFILE" ], "type": "string", "description": "Service profile type", "example": "L2_PROFILE", "x-eqx-api-linter-skip-rules": [ 40 ] } }, { "name": "name", "description": "Customer-assigned service profile name", "required": true, "schema": { "maxLength": 50, "type": "string", "description": "Customer-assigned service profile name", "example": "Sample Service Profile" } }, { "name": "description", "description": "User-provided service description should be of maximum length 375", "required": true, "schema": { "type": "string", "description": "User-provided service description should be of maximum length 375", "example": "offering connectivity to my-network" } }, { "name": "href", "description": "Service Profile URI response attribute", "required": false, "schema": { "type": "string", "description": "Service Profile URI response attribute", "format": "uri" } }, { "name": "uuid", "description": "Equinix-assigned service profile identifier", "required": false, "schema": { "type": "string", "description": "Equinix-assigned service profile identifier", "format": "uuid" } }, { "name": "notifications", "description": "Recipients of notifications on service profile change", "required": false, "schema": { "$ref": "#/components/schemas/Notifications_f30d1188" } }, { "name": "tags", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "visibility", "required": false, "schema": { "enum": [ "PRIVATE", "PUBLIC" ], "type": "string" } }, { "name": "allowedEmails", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "email" } } }, { "name": "accessPointTypeConfigs", "required": false, "schema": { "$ref": "#/components/schemas/AccessPointTypeConfigs" } }, { "name": "customFields", "required": false, "schema": { "$ref": "#/components/schemas/CustomFields" } }, { "name": "marketingInfo", "required": false, "schema": { "$ref": "#/components/schemas/MarketingInfo" } }, { "name": "ports", "required": false, "schema": { "$ref": "#/components/schemas/Ports" } }, { "name": "virtualDevices", "required": false, "schema": { "$ref": "#/components/schemas/VirtualDevices" } }, { "name": "metros", "description": "Derived response attribute.", "required": false, "schema": { "$ref": "#/components/schemas/Metros" } }, { "name": "environments", "description": "Provider environments associated with this IC_PROFILE service profile. Beta", "required": false, "schema": { "$ref": "#/components/schemas/Environments" } }, { "name": "selfProfile", "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker.", "required": false, "schema": { "type": "boolean", "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker." } }, { "name": "projectId", "required": false, "schema": { "type": "string" } }, { "name": "lastMileConfig", "description": "Last-mile provider catalogs and offerings available for this service profile.", "required": false, "schema": { "$ref": "#/components/schemas/LastMileConfig" } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } } ], "result": { "name": "fabric_putServiceProfileByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceProfileResult" } }, "x-mcp-annotations": { "title": "Replace Service Profile", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_replaceConnectionRoutingProtocolByUuid", "summary": "Replace Protocol", "description": "This API provides capability to replace complete Routing Protocols on a virtual connection\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routingProtocolId", "description": "Routing Protocol UUID", "required": true, "schema": { "type": "string", "description": "Routing Protocol UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "description": "Routing protocol type", "required": true, "schema": { "enum": [ "BGP", "DIRECT" ], "type": "string", "description": "Routing protocol type" } } ], "result": { "name": "fabric_replaceConnectionRoutingProtocolByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_a1b7bd9c" } }, "x-mcp-annotations": { "title": "Replace Protocol", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_replaceRouteAggregationRuleByUuid", "summary": "Replace Route Aggregation Rule", "description": "This API provides capability to replace a Route Aggregation Rule completely\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeAggregationRuleId", "description": "Route Aggregation Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregation Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "prefix", "required": true, "schema": { "type": "string", "example": "192.168.0.0/24" } }, { "name": "name", "required": false, "schema": { "type": "string", "example": "Private-subnet-Aggregation" } }, { "name": "description", "description": "Customer-provided Route Aggregation Rule description", "required": false, "schema": { "type": "string", "description": "Customer-provided Route Aggregation Rule description" } } ], "result": { "name": "fabric_replaceRouteAggregationRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteAggregationRuleResult" } }, "x-mcp-annotations": { "title": "Replace Route Aggregation Rule", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_replaceRouteFilterRuleByUuid", "summary": "Replace Route Filter Rule", "description": "This API provides capability to replace a Route Filter Rule completely\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "routeFilterRuleId", "description": "Route Filter Rule UUID", "required": true, "schema": { "type": "string", "description": "Route Filter Rule UUID", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" } }, { "name": "prefix", "required": true, "schema": { "type": "string", "example": "192.168.0.0/24" } }, { "name": "name", "required": false, "schema": { "type": "string", "example": "Private-subnet-filter" } }, { "name": "description", "description": "Customer-provided Route Filter Rule description", "required": false, "schema": { "type": "string", "description": "Customer-provided Route Filter Rule description" } }, { "name": "prefixMatch", "required": false, "schema": { "type": "string", "default": "orlonger", "example": "orlonger, exact" } } ], "result": { "name": "fabric_replaceRouteFilterRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createRouteFilterRuleResult" } }, "x-mcp-annotations": { "title": "Replace Route Filter Rule", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAppDomains", "summary": "Search Domains", "description": "The API provides capability to get list of user's App Domains using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Domains" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_2c83a590" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_2c83a590" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/name` - App Domain name\n * `/uuid` - App Domain uuid\n * `/state` - App Domain status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAppDomainsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "name", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_DOMAIN" ], "type": "string", "description": "App Domain Type", "default": "APP_DOMAIN", "example": "APP_DOMAIN", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Domain name", "format": "string", "example": "atlassian.net", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Domain description", "format": "string", "example": "Atlassian Domain", "x-order": 5 }, "state": { "enum": [ "PENDING_VERIFICATION", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED" ], "type": "string", "description": "App Domain lifecycle state", "format": "string", "example": "PENDING_VERIFICATION", "x-order": 6 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_cbb82a68" } }, "description": "App Domain object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppDomainSearchResponse" } }, "x-mcp-annotations": { "title": "Search Domains", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAppLinks", "summary": "Search Links", "description": "The API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_b1b502bb" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_b1b502bb" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/name` - App Link name\n * `/uuid` - App Link uuid\n * `/state` - App Link status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAppLinksResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "name", "router", "ipv4Subnet", "bandwidth", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 1 }, "type": { "enum": [ "APP_LINK" ], "type": "string", "description": "App Link Type", "default": "APP_LINK", "example": "APP_LINK", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Link name", "format": "string", "example": "Atlassian App Link", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Link description", "format": "string", "example": "Atlassian App Link in SV", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Link lifecycle state", "format": "string", "example": "PROVISIONING", "x-order": 6 }, "router": { "$ref": "#/components/schemas/Router_81684de7" }, "ipv4Subnet": { "type": "string", "description": "Customer-provided IP subnet for AppLink setup (/29 or larger subnet)", "example": "192.168.10.0/29", "x-order": 8 }, "ipv4Address": { "type": "string", "description": "App Link IP address", "format": "ipv4", "example": "192.168.10.1", "x-order": 9 }, "bandwidth": { "type": "integer", "description": "App Link aggregated data transfer capacity in Mbps", "example": 1000, "x-order": 10 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_83160f21" } }, "description": "App Link object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppLinkSearchResponse" } }, "x-mcp-annotations": { "title": "Search Links", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAppProcessors", "summary": "Search Processors", "description": "The API provides capability to get list of user's App Processors using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Processors" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_c7b7b656" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_c7b7b656" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/name` - App Processor name\n * `/uuid` - App Processor uuid\n * `/state` - App Processor status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAppProcessorsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "name", "registryId", "marketplace", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 1 }, "type": { "enum": [ "APP_PROCESSOR" ], "type": "string", "description": "App Processor Type", "default": "APP_PROCESSOR", "example": "APP_PROCESSOR", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 3 }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Customer-provided App Processor name", "format": "string", "example": "agent-gateway", "x-order": 4 }, "description": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Customer-provided App Processor description", "format": "string", "example": "llm-routing, a2a-routing, mcp-routing", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Processor lifecycle state", "format": "string", "example": "PROVISIONING", "x-order": 6 }, "registryId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Container image reference for the processor runtime", "format": "string", "example": "agentgateway/agentgateway:1.3.0", "x-order": 7 }, "marketplace": { "required": [ "visibility" ], "type": "object", "properties": { "visibility": { "enum": [ "PUBLIC", "PRIVATE" ], "type": "string", "description": "App Processor marketplace visibility", "format": "string", "default": "PUBLIC", "example": "PUBLIC" } }, "description": "App Processor marketplace settings", "x-order": 8 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_e92ba39a" } }, "description": "App Processor object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppProcessorSearchResponse" } }, "x-mcp-annotations": { "title": "Search Processors", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAppServices", "summary": "Search Services", "description": "The API provides capability to get list of user's App Services using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_cbfced43" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_cbfced43" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/name` - App Service name\n * `/uuid` - App Service uuid\n * `/state` - App Service status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAppServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "name" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 1 }, "type": { "enum": [ "APP_SERVICE" ], "type": "string", "description": "App Service Type", "default": "APP_SERVICE", "example": "APP_SERVICE", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Service name", "format": "string", "example": "Atlassian App Service", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Service description", "format": "string", "example": "Atlassian App Service in SV", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Service lifecycle state", "example": "PROVISIONING", "x-order": 6 }, "endpoint": { "type": "string", "description": "Accessible endpoint through this service", "example": "equinixjira.atlassian.net", "x-order": 7 }, "sourceDomains": { "type": "array", "items": { "type": "string", "example": "equinix.com" }, "description": "List of source domains from where traffic is allowed", "x-order": 8 }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_0b77c634" } }, "description": "App Service object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppServiceSearchResponse" } }, "x-mcp-annotations": { "title": "Search Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAppSubscriptions", "summary": "Search Subscriptions", "description": "The API provides capability to get list of user's App Subscriptions using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_8c14da5c" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_8c14da5c" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/uuid` - App Subscription uuid\n * `/state` - App Subscription status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAppSubscriptionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "source", "target", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_SUBSCRIPTION" ], "type": "string", "description": "App Subscription Type", "default": "APP_SUBSCRIPTION", "example": "APP_SUBSCRIPTION", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "source": { "$ref": "#/components/schemas/Source" }, "target": { "$ref": "#/components/schemas/Target" }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Subscription lifecycle state", "example": "PROVISIONING", "x-order": 6 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_7b17b91f" } }, "description": "App Subscription object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppSubscriptionSearchResponse" } }, "x-mcp-annotations": { "title": "Search Subscriptions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAsns", "summary": "Search ASNs", "description": "Search for ASN records based on criteria\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "ASNs" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/SearchExpression" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AsnSearchSortCriteria" } } } ], "result": { "name": "fabric_searchAsnsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string", "description": "Unique identifier for the ASN record", "format": "uuid", "example": "6db706f8-2a37-4546-a3ed-1df113a84d43" }, "state": { "$ref": "#/components/schemas/State_a5c353e9" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "number": { "type": "integer", "description": "Autonomous System Number", "format": "int64", "example": 64497 }, "rirRegion": { "enum": [ "AFRINIC", "APNIC", "ARIN", "LACNIC", "RIPE_NCC" ], "type": "string", "description": "Regional Internet Registry region" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "range": { "enum": [ "16_BIT", "32_BIT" ], "type": "string", "description": "ASN range selection" }, "ownershipChallengeDetails": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "RPKI", "LOA" ], "type": "string", "description": "Type of ownership challenge", "x-enum-varnames": [ "RPKI", "LOA" ] } }, "description": "Ownership challenge details for public ASN verification" }, "change": { "type": "object", "properties": { "href": { "type": "string", "description": "URL path to the change event", "example": "/cloudEvents" } }, "description": "Change reference for ASN" }, "assets": { "$ref": "#/components/schemas/Assets_7c79a22a" }, "errors": { "$ref": "#/components/schemas/Errors_81abeebb" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "ASN Record" } } }, "x-fastmcp-top-level-schema": "AsnSearchResponseBody" } }, "x-mcp-annotations": { "title": "Search ASNs", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAttachedAppDomains", "summary": "Search Attached Domains for Link", "description": "The API provides capability to get list of user's attached App Domains using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_58ed4f6e" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_58ed4f6e" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/uuid` - App Domain attach to App Link uuid\n * `/attachmentStatus` - App Domain attach to App Link status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAttachedAppDomainsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_DOMAIN" ], "type": "string", "description": "App Domain Type", "default": "APP_DOMAIN", "example": "APP_DOMAIN", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Domain name", "example": "atlassian.net", "x-order": 4 }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "App Link Attached App Domain object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppLinkAttachDomainSearchResponse" } }, "x-mcp-annotations": { "title": "Search Attached Domains for Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAttachedAppProcessors", "summary": "Search attached Processors to Link", "description": "The API provides capability to get list of App Processors attached to an App Link using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_384c5f84" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_384c5f84" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/uuid` - App Processor attach to App Link uuid\n * `/attachmentStatus` - App Processor attach to App Link status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAttachedAppProcessorsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_3f870086" } }, "x-fastmcp-top-level-schema": "AppLinkAttachProcessorSearchResponse" } }, "x-mcp-annotations": { "title": "Search attached Processors to Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAttachedAppServices", "summary": "Search Attached Services for Link", "description": "The API provides capability to get list of user's attached App Services using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_502845be" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_502845be" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/uuid` - App Service attach to App Link uuid\n * `/attachmentStatus` - App Service attach to App Link status\n * `/changeLog/createdDateTime` - Date and time when change flow starts\n * `/changeLog/updatedDateTime` - Date and time when change object is updated\n", "format": "string", "default": "/changeLog/updatedDateTime", "example": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchAttachedAppServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "uuid", "geoScope", "destinationIp" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 1 }, "type": { "enum": [ "APP_SERVICE" ], "type": "string", "description": "App Service Type", "default": "APP_SERVICE", "example": "APP_SERVICE", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 3 }, "geoScope": { "type": "string", "description": "Geo scope for the App Service", "example": "GLOBAL", "x-order": 4 }, "destinationIp": { "type": "string", "description": "Target IP for forwarding API requests", "format": "ipv4", "example": "10.10.1.110", "x-order": 5 }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_e362f715" } }, "description": "App Link Attached App Service object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "AppLinkAttachServiceSearchResponse" } }, "x-mcp-annotations": { "title": "Search Attached Services for Link", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchAttachedAppSubscriptionsByAppServiceId", "summary": "Search Attached Subscriptions", "description": "The API provides capability to get list of App Subscriptions attached to an App Service using search criteria\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_457cf0a7" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_457cf0a7" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on '400_InvalidSorting':\n * `/uuid` - App Subscription UUID\n * `/state` - App Subscription lifecycle state\n", "format": "string", "default": "/uuid", "example": "/uuid" } } } } } ], "result": { "name": "fabric_searchAttachedAppSubscriptionsByAppServiceIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_17ed86c9" } }, "x-fastmcp-top-level-schema": "AppServiceAttachedAppSubscriptionSearchResponse" } }, "x-mcp-annotations": { "title": "Search Attached Subscriptions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCloudEvents", "summary": "Search Cloud Events", "description": "This API provides capability to search cloud events from a filtered query\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Events" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": true, "schema": { "type": "object", "properties": { "and": { "type": "array", "items": { "type": "object", "anyOf": [ { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/id` - Cloud Event identifier\n * `/subject` - Cloud Event subject description\n * `/type` - Cloud Event type\n * `/time` - Time of Cloud Events\n * `/equinixproject` - Equinix Project of Cloud Events\n * `/equinixorganization` - Equinix Organization of Cloud Events\n * `/equinixalert` - Equinix Alert Identifier for raise/clear Cloud Events\n * `/severitytext` - cloud event severity text\n * `/authid` - Equinix user key to identify the user that performed the action that triggered the Cloud Event\n * `/authtype` - Equinix user type either user or system\n", "example": "/subject" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `>` - greater than\n * `>=` - greater than or equal to\n * `<` - less than\n * `<=` - less than or equal to\n * `BETWEEN` - between\n * `IN` - in\n * `LIKE` - like\n * `ILIKE` - like case-insensitive\n * `IS NULL` - is null\n * `IS NOT NULL` - is not null\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "equinix.fabric.port.status.*" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } } ], "result": { "name": "fabric_searchCloudEventsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getCloudEventByAssetIdResult" } }, "x-mcp-annotations": { "title": "Search Cloud Events", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCloudRouterCommands", "summary": "Search Commands", "description": "This API provides capability to search commands\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_a41728ec" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_a41728ec" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/name", "/type" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchCloudRouterCommandsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_5b5fb9cb" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "CloudRouterCommandSearchResponse" } }, "x-mcp-annotations": { "title": "Search Commands", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCloudRouterRouteAggregationAttachments", "summary": "Search Cloud Router Route Aggregation Attachments", "description": "This API provides capability to search route aggregation attachments for a given cloud router Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/CloudRouterRouteAggregationsFilter" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "sort", "required": false, "schema": { "maxItems": 3, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RaAttachmentSortItem" } } } ], "result": { "name": "fabric_searchCloudRouterRouteAggregationAttachmentsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_0b2bd7bb" }, "description": "List of route aggregation attachments for a given cloud router" } }, "x-fastmcp-top-level-schema": "CloudRouterRouteAggregationsSearchResponse" } }, "x-mcp-annotations": { "title": "Search Cloud Router Route Aggregation Attachments", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCloudRouterRouteFilterAttachments", "summary": "Search Cloud Router Route Filter Attachments", "description": "This API provides capability to search route filter attachments for a given cloud router Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/CloudRouterRouteFiltersFilter" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "sort", "required": false, "schema": { "maxItems": 3, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RfAttachmentSortItem" } } } ], "result": { "name": "fabric_searchCloudRouterRouteFilterAttachmentsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_2cd3d0bb" }, "description": "List of route filter attachments for a given cloud router" } }, "x-fastmcp-top-level-schema": "CloudRouterRouteFiltersSearchResponse" } }, "x-mcp-annotations": { "title": "Search Cloud Router Route Filter Attachments", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCloudRouterRoutes", "summary": "Search Route Tables", "description": "The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_d21b92ee" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_d21b92ee" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/prefix", "/nextHop", "/connection/name", "/type", "/MED" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchCloudRouterRoutesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "required": [ "type", "state", "changeLog" ], "type": "object", "properties": { "type": { "enum": [ "IPv4_BGP_ROUTE", "IPv4_STATIC_ROUTE", "IPv4_DIRECT_ROUTE", "IPv6_BGP_ROUTE", "IPv6_STATIC_ROUTE", "IPv6_DIRECT_ROUTE" ], "type": "string", "description": "Route table entry type", "example": "IPv4_BGP_SESSION" }, "protocolType": { "enum": [ "BGP", "STATIC", "DIRECT" ], "type": "string", "description": "Route table entry protocol type", "example": "BGP" }, "state": { "enum": [ "ACTIVE" ], "type": "string", "description": "Route table entry state", "example": "ACTIVE" }, "prefix": { "type": "string", "example": "192.168.10.0/24" }, "nextHop": { "type": "string", "example": "10.10.10.5" }, "MED": { "type": "integer", "example": 5 }, "localPreference": { "type": "integer", "example": 200 }, "asPath": { "type": "array", "items": { "type": "string", "example": "20100" } }, "connection": { "type": "object", "properties": { "uuid": { "type": "string", "example": "81331c52-04c0-4656-a4a7-18c52669348f" }, "name": { "type": "string", "example": "connection_1" }, "href": { "type": "string", "format": "uri" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Route table entry object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "RouteTableEntrySearchResponse" } }, "x-mcp-annotations": { "title": "Search Route Tables", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCloudRouters", "summary": "Search Routers", "description": "The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/CloudRouterExpression" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CloudRouterSortCriteria" } } } ], "result": { "name": "fabric_searchCloudRoutersResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "IC_ROUTER", "XF_ROUTER" ], "type": "string" }, "name": { "type": "string", "description": "Customer-provided Cloud Router name" }, "location": { "$ref": "#/components/schemas/Location_32724e48" }, "package": { "$ref": "#/components/schemas/Package" }, "order": { "$ref": "#/components/schemas/Order_3e7328e1" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_903ff2b6" }, "href": { "type": "string", "description": "Cloud Routers URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "state": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "REPROVISIONING", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Access point lifecycle state", "example": "PROVISIONED" }, "equinixAsn": { "type": "integer", "description": "Equinix ASN", "format": "int64", "example": 30000 }, "connectionsCount": { "minimum": 0.0, "type": "integer", "description": "Number of connections associated with this Access point" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_3a596f52" } }, "description": "Fabric Cloud Router read response object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "SearchResponse" } }, "x-mcp-annotations": { "title": "Search Routers", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCompanyProfile", "summary": "Search Company Profiles", "description": "Search company profiles based on filter criteria Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Company Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "viewPoint", "description": "Viewpoint for the request, either 'aSide' or 'zSide'", "required": false, "schema": { "type": "string", "default": "aSide", "description": "Viewpoint for the request, either 'aSide' or 'zSide'" } }, { "name": "filter", "description": "Filter criteria for company profile search. The `and` array combines conditions where all must match. Each item in `and` is either a simple expression (property/operator/values) or an `or` group. At most one `or` group is allowed per request.\n", "required": false, "schema": { "type": "object", "properties": { "and": { "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_e20022a7" }, { "required": [ "or" ], "type": "object", "properties": { "or": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_e20022a7" } } }, "description": "Groups multiple simple expressions with OR logic. At most one `or` group is allowed within the top-level `and` array.\n" } ] } } }, "description": "Filter criteria for company profile search. The `and` array combines conditions where all must match. Each item in `and` is either a simple expression (property/operator/values) or an `or` group. At most one `or` group is allowed per request.\n" } }, { "name": "pagination", "description": "Pagination response information", "required": false, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "sort", "required": false, "schema": { "type": "object", "properties": { "property": { "type": "string", "description": "Property to sort by. Supported values:\n * `/name` - Company profile name\n * `/state` - Company profile state\n * `/changeLog/updatedDateTime` - Date and time the profile was last updated\n * `/changeLog/createdDateTime` - Date and time the profile was created\n", "example": "/changeLog/updatedDateTime" }, "direction": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "ASC" } } } } ], "result": { "name": "fabric_searchCompanyProfileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000" }, "uuid": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "type": "string", "example": "COMPANY_PROFILE" }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "example": "Equinix" }, "summary": { "maxLength": 125, "minLength": 1, "type": "string", "example": "Global interconnection and data center company" }, "description": { "maxLength": 450, "minLength": 1, "type": "string", "example": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers." }, "state": { "type": "string", "description": "Company Profile State" }, "metros": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "metroCode": { "type": "string" } } }, "example": [ { "href": "https://api.equinix.com/fabric/v4/metros/SV", "metroCode": "SV" } ] }, "logo": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string" }, "extensionType": { "type": "string" } } }, "tags": { "$ref": "#/components/schemas/Tags_d567d07b" }, "serviceProfiles": { "$ref": "#/components/schemas/ServiceProfiles" }, "privateServices": { "$ref": "#/components/schemas/PrivateServices" }, "pointOfContacts": { "$ref": "#/components/schemas/PointOfContacts" }, "notifications": { "$ref": "#/components/schemas/Notifications_ebd7698b" }, "overview": { "type": "string", "example": "About Initech Corp

lorem ipsum

" }, "webUrl": { "type": "string", "example": "https://www.equinix.com" }, "contactUrl": { "type": "string", "example": "https://www.equinix.com/contact-us" }, "change": { "$ref": "#/components/schemas/Change_f9a00c8a" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } } } }, "x-fastmcp-top-level-schema": "CompanyProfileSearchResponse" } }, "x-mcp-annotations": { "title": "Search Company Profiles", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchConnectionAdvertisedRoutes", "summary": "Search Advertised Routes", "description": "The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/Filter_a9830638" } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_26d808b4" } } ], "result": { "name": "fabric_searchConnectionAdvertisedRoutesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_searchConnectionAdvertisedRoutesResult" } }, "x-mcp-annotations": { "title": "Search Advertised Routes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchConnectionReceivedRoutes", "summary": "Search Received Routes", "description": "The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/Filter_a9830638" } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_26d808b4" } } ], "result": { "name": "fabric_searchConnectionReceivedRoutesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_searchConnectionAdvertisedRoutesResult" } }, "x-mcp-annotations": { "title": "Search Received Routes", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchConnections", "summary": "Search Connections", "description": "The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Connections" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/Expression" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SortCriteria" } } } ], "result": { "name": "fabric_searchConnectionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "$ref": "#/components/schemas/SortBy" } } } }, "data": { "$ref": "#/components/schemas/Data_2d124c60" } }, "description": "List of connections", "x-fastmcp-top-level-schema": "ConnectionSearchResponse" } }, "x-mcp-annotations": { "title": "Search Connections", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCrossConnectAction", "summary": "Search Cross Connect Actions", "description": "The API provides capability to get list of Cross Connect Actions using search criteria, including optional filtering, pagination and sorting.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "crossConnectId", "description": "Cross Connect UUID.", "required": true, "schema": { "type": "string", "description": "Cross Connect UUID.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_6ecd3b31" }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/components/schemas/AndItem_6ecd3b31" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_4cbe2ffe" } } ], "result": { "name": "fabric_searchCrossConnectActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "$ref": "#/components/schemas/Sort_4cbe2ffe" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Action URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4" }, "uuid": { "type": "string", "description": "Action Identifier.", "format": "uuid", "example": "30cc7878-54e3-4e1a-8651-87a61354bad4" }, "type": { "$ref": "#/components/schemas/Type_0116f717" }, "state": { "allOf": [ { "enum": [ "PENDING", "COMPLETED", "FAILED" ], "type": "string", "description": "Cross Connect Action State.", "example": "COMPLETED" } ] }, "data": { "$ref": "#/components/schemas/Data_f0a6c239" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_998bd88d" } }, "description": "Cross Connect Action Response." } } }, "description": "List of Cross Connect Actions.", "x-fastmcp-top-level-schema": "CrossConnectActionSearchResponse" } }, "x-mcp-annotations": { "title": "Search Cross Connect Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCrossConnectSchedules", "summary": "Search Cross Connect Schedules", "description": "The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "property": { "enum": [ "/type", "/code", "/aSide/location/ibxCode", "/zSide/location/ibxCode" ], "type": "string", "description": "Possible field names to use on filters.", "example": "/aSide/location/ibxCode" }, "operator": { "enum": [ "=", "!=", "IN", "NOT IN" ], "type": "string", "example": "=" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "SV11" ] } } } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_e73065ca" } } ], "result": { "name": "fabric_searchCrossConnectSchedulesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "$ref": "#/components/schemas/Sort_e73065ca" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Schedule URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE" }, "type": { "enum": [ "XC_INSTALL_SCHEDULE" ], "type": "string", "description": "Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule windows.\n", "example": "XC_INSTALL_SCHEDULE" }, "code": { "allOf": [ { "enum": [ "STANDARD", "FLEXIBLE", "EXPEDITE" ], "type": "string", "description": "Schedule Code.", "example": "STANDARD" } ] }, "aSide": { "type": "object", "properties": { "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code.", "example": "SV1" } }, "description": "Cross Connect Location details." } }, "description": "A-Side of the schedule window." }, "zSide": { "type": "object", "properties": { "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code.", "example": "SV1" } }, "description": "Cross Connect Location details." } }, "description": "Z-Side of the schedule window." }, "startDateTime": { "type": "string", "description": "Start of the schedule window.", "format": "date-time", "example": "2026-03-05T17:00:00Z" }, "endDateTime": { "type": "string", "description": "End of the schedule window.", "format": "date-time", "example": "2026-03-10T17:24:00Z" }, "unavailableDates": { "type": "array", "items": { "type": "string", "format": "date", "example": "2026-03-07" }, "description": "Dates within the schedule window when the IBX is unavailable, such as the holidays observed at the IBX.\n" } }, "description": "Cross Connect schedule window offered at an IBX." } } }, "description": "List of Cross Connect schedule windows offered at an IBX.", "x-fastmcp-top-level-schema": "SearchSchedulesResponse" } }, "x-mcp-annotations": { "title": "Search Cross Connect Schedules", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchCrossConnects", "summary": "Search Cross Connects", "description": "The API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cross Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_fa49c441" }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/components/schemas/AndItem_fa49c441" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_2898cbcc" } } ], "result": { "name": "fabric_searchCrossConnectsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "$ref": "#/components/schemas/Sort_2898cbcc" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_1eef7681" } } }, "description": "List of Cross Connects.", "x-fastmcp-top-level-schema": "CrossConnectSearchResponse" } }, "x-mcp-annotations": { "title": "Search Cross Connects", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchEiaServices", "summary": "Search Internet Access Services", "description": "Search for Internet Access Services\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Access Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/SearchExpression" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/SearchSort" } } ], "result": { "name": "fabric_searchEiaServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "sort", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "type": "array", "items": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "enum": [ "ASC", "DESC" ], "type": "string", "example": "ASC" }, "property": { "type": "string" } } } }, "data": { "type": "array", "items": { "required": [ "href", "type", "uuid", "name", "state", "change", "routingProtocol", "billing", "account", "project", "order", "changeLog", "useCase" ], "type": "object", "properties": { "href": { "type": "string", "description": "Service URL path", "format": "uri", "example": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4" }, "type": { "enum": [ "SINGLE_IA", "DUAL_IA" ], "type": "string", "description": "Type of the service, either single or dual internet access", "x-enum-varnames": [ "SINGLE_IA", "DUAL_IA" ] }, "uuid": { "type": "string", "description": "Unique identifier for the EIA Service", "format": "uuid" }, "name": { "type": "string", "description": "The name of the EIA Service" }, "bandwidth": { "type": "integer", "description": "Bandwidth of the service" }, "bandwidthCommit": { "type": "integer", "description": "Minimum bandwidth commit for burst billing variant of the service" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "FAILED", "DEPROVISIONING", "DEPROVISIONED" ], "type": "string", "description": "Current state of the service", "x-enum-varnames": [ "PROVISIONING", "PROVISIONED", "FAILED", "DEPROVISIONING", "DEPROVISIONED" ] }, "change": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the change object", "format": "uri" } } }, "locations": { "$ref": "#/components/schemas/Locations_cc851082" }, "routingProtocol": { "$ref": "#/components/schemas/RoutingProtocol_3cbb1e72" }, "billing": { "$ref": "#/components/schemas/Billing_e95cc35e" }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account number" }, "href": { "type": "string", "description": "Account URL path", "format": "uri", "example": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234" } } }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "order": { "$ref": "#/components/schemas/Order_756ea9ac" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "useCase": { "enum": [ "MAIN", "MANAGEMENT_ACCESS" ], "type": "string", "x-enum-varnames": [ "MAIN", "MANAGEMENT_ACCESS" ] } } } } }, "x-fastmcp-top-level-schema": "InternetAccessServices" } }, "x-mcp-annotations": { "title": "Search Internet Access Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchExchangeService", "summary": "Search Internet Exchange Services", "description": "The API provides capability to get list of user's Internet Exchange Service using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Exchange Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ExchangeServiceSearchExpression" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangeServiceSearchSortCriteria" } } } ], "result": { "name": "fabric_searchExchangeServiceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangeServiceSearchSortCriteria" } }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Internet Exchange Service URI", "example": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011" }, "uuid": { "type": "string", "description": "Internet Exchange Service identifier", "format": "uuid", "example": "a8ba52de-faae-43b5-b0b1-6904d37ee011" }, "type": { "enum": [ "IX" ], "type": "string", "description": "Internet Exchange Service Type", "default": "IX", "example": "IX" }, "name": { "type": "string", "description": "Name", "example": "ix_exchange_service" }, "bandwidth": { "type": "integer", "description": "bandwidth in Mbps", "example": 400000 }, "description": { "type": "string", "description": "Description", "example": "ix_exchange_service" }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATING_FAILED", "PROVISIONED", "REPROVISIONING", "REPROVISIONING_FAILED", "DEPROVISIONING", "DEPROVISIONED", "DEPROVISIONING_FAILED" ], "type": "string", "description": "State", "example": "PROVISIONING" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "publicPeeringConnection": { "$ref": "#/components/schemas/PublicPeeringConnection" }, "routingProtocol": { "$ref": "#/components/schemas/RoutingProtocol_61df553d" }, "order": { "$ref": "#/components/schemas/Order_42dc2ad5" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_a0ca161e" }, "changelog": { "$ref": "#/components/schemas/Changelog" }, "additionalInfo": { "$ref": "#/components/schemas/AdditionalInfo_35e07328" } } } } }, "description": "List of Internet Exchange Service", "x-fastmcp-top-level-schema": "ExchangeServiceSearchResponse" } }, "x-mcp-annotations": { "title": "Search Internet Exchange Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchIpBlocks", "summary": "Search IP Blocks", "description": "Search for IP Blocks based on criteria\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "IP Blocks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "type": "array", "items": { "required": [ "property", "operator", "values" ], "type": "object", "properties": { "property": { "type": "string" }, "operator": { "enum": [ "=" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } } } } } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "enum": [ "ASC", "DESC" ], "type": "string", "example": "ASC" }, "property": { "type": "string" } } } } } ], "result": { "name": "fabric_searchIpBlocksResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "required": [ "pagination", "data" ], "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "type": "array", "items": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "enum": [ "ASC", "DESC" ], "type": "string", "example": "ASC" }, "property": { "type": "string" } } } }, "data": { "type": "array", "items": { "required": [ "uuid", "href", "state", "type", "ownership", "prefixLength", "project", "changeLog" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier for the IP Block", "format": "uuid" }, "href": { "type": "string", "description": "Resource URL path for the IP Block", "example": "/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb" }, "type": { "enum": [ "IPV4_IP_BLOCK", "IPV6_IP_BLOCK" ], "type": "string", "x-enum-varnames": [ "IPV4_IP_BLOCK", "IPV6_IP_BLOCK" ] }, "state": { "enum": [ "PENDING", "ACTIVE", "DELETING", "DELETED", "FAILED" ], "type": "string", "description": "Current state of the IP Block" }, "ownership": { "enum": [ "EQUINIX", "CUSTOMER" ], "type": "string", "description": "IpBlockOwnership of the IP Block" }, "location": { "required": [ "metroCode" ], "type": "object", "properties": { "metroHref": { "type": "string", "description": "Metro URL path for the linked resource", "example": "https://api.equinix.com/fabric/v4/metros/WA" }, "metroCode": { "pattern": "^[A-Z]{2}$", "type": "string", "example": "WA" } } }, "prefixLength": { "maximum": 128.0, "minimum": 1.0, "type": "integer", "description": "IpBlockPrefix length" }, "prefix": { "type": "string", "description": "CIDR prefix" }, "order": { "required": [ "href", "orderNumber" ], "type": "object", "properties": { "href": { "type": "string", "description": "Order URI", "format": "uri", "example": "https://api.equinix.com/colocations/v2/orders/1-34834234" }, "orderNumber": { "type": "string", "description": "Order number" } } }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "account number" } } }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the project", "format": "uri" }, "projectId": { "type": "string", "description": "project id" } } }, "regulations": { "$ref": "#/components/schemas/Regulations" }, "assets": { "$ref": "#/components/schemas/Assets_a652916b" }, "change": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the IpBlockChange object", "format": "uri" } } }, "changeLog": { "required": [ "createdDateTime" ], "type": "object", "properties": { "createdDateTime": { "type": "string", "format": "date-time" }, "updatedDateTime": { "type": "string", "format": "date-time" }, "deletedDateTime": { "type": "string", "format": "date-time" } } }, "error": { "$ref": "#/components/schemas/ErrorsItem_425b1fcf" } } } } }, "x-fastmcp-top-level-schema": "IpBlockSearchResponseBody" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Search IP Blocks", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchLastOpEvents", "summary": "Search last Operational Cloud Events", "description": "This API provides capability to search last operational cloud events from a filtered query\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Events" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "type": "array", "items": { "type": "object", "anyOf": [ { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/subject` - Cloud Event subject description\n", "example": "/subject" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `IN` - in\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } } ], "result": { "name": "fabric_searchLastOpEventsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_08f4c8d1" } }, "x-fastmcp-top-level-schema": "SearchLiveEventResponse" } }, "x-mcp-annotations": { "title": "Search last Operational Cloud Events", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchLoa", "summary": "Search Loas", "description": "The API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_a6113db6" }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/components/schemas/AndItem_a6113db6" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_57c2d2b3" } } ], "result": { "name": "fabric_searchLoaResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "$ref": "#/components/schemas/Sort_57c2d2b3" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "URI of this LOA resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2" }, "uuid": { "type": "string", "description": "Unique identifier of this LOA.", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" }, "type": { "enum": [ "CAGE_LOA", "PATCH_PANEL_LOA", "PATCH_PANEL_PORT_LOA" ], "type": "string", "description": "Type of Letter of Authorization\n", "example": "PATCH_PANEL_PORT_LOA" }, "name": { "type": "string", "description": "A short, descriptive name for this LOA", "example": "LOA-Equinix-SV1-2026" }, "description": { "type": "string", "description": "Additional context about this LOA", "example": "Authorization for patch panel port access to Equinix at SV1" }, "authorizedProductType": { "enum": [ "XC", "XF_PORT", "VD" ], "type": "string", "description": "Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge\n", "example": "XC" }, "state": { "enum": [ "PENDING", "FAILED", "PENDING_AUTHORIZATION", "PENDING_ACCEPTANCE", "CANCELLED", "INACTIVE", "ACTIVE", "EXPIRED" ], "type": "string", "description": "Current lifecycle state of the LOA.", "example": "ACTIVE" }, "operation": { "type": "object", "properties": { "consumersCount": { "type": "integer", "description": "Number of consumers associated with this LOA.", "example": 10 } } }, "requestor": { "$ref": "#/components/schemas/Requestor" }, "issuer": { "$ref": "#/components/schemas/Issuer" }, "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_27ae5d2c" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code", "example": "AM1" } }, "description": "Eligible location where LOA can be issued." }, "expirationDateTime": { "type": "string", "description": "Date and time when this LOA expires.
Default to 3 months from the creation date\n", "format": "date-time", "example": "2026-11-06T07:00:00Z" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_c32c50f9" } }, "description": "Loa Response" } } }, "description": "List of LOAs", "x-fastmcp-top-level-schema": "LoaSearchResponse" } }, "x-mcp-annotations": { "title": "Search Loas", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchLoaAction", "summary": "Search Loa Actions", "description": "The API provides capability to get list of user's Loa Actions using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_9a109001" }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/components/schemas/AndItem_9a109001" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_ef18c327" } } ], "result": { "name": "fabric_searchLoaActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "$ref": "#/components/schemas/Sort_ef18c327" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Action URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4" }, "uuid": { "type": "string", "description": "Action Identifier", "format": "uuid", "example": "30cc7878-54e3-4e1a-8651-87a61354bad4" }, "state": { "enum": [ "COMPLETED", "FAILED", "PENDING" ], "type": "string", "description": "Action State" }, "type": { "enum": [ "LOA_ISSUER_AUTHORIZATION", "LOA_REQUESTOR_ACCEPTANCE", "LOA_COPY_LINK", "LOA_SEND_EMAIL_NOTIFICATION", "LOA_CANCEL" ], "type": "string", "description": "Action to perform on the LOA.", "example": "LOA_ISSUER_AUTHORIZATION" }, "data": { "$ref": "#/components/schemas/Data_66916414" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_c32c50f9" } }, "description": "Action Response" } } }, "description": "List of LOA Actions", "x-fastmcp-top-level-schema": "LoaActionSearchResponse" } }, "x-mcp-annotations": { "title": "Search Loa Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchMetrics", "summary": "Search Metrics", "description": "This API provides capability to search metrics from a filtered query\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Metrics" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": true, "schema": { "type": "object", "properties": { "and": { "type": "array", "items": { "type": "object", "anyOf": [ { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/subject` - Metric subject description (required and limited to 1 value)\n * `/name` - Metric names (required)\n * `/dataPoints/endDateTime` - Time of Metrics\n * `/time` - Time of Metrics\n * `/interval` - ISO-8601 duration format to specify the interval of metrics data points\n * `/value` - specific data points of the metric to return (e.g. 'last' - for metros only)\n", "example": "/subject" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `>` - greater than\n * `>=` - greater than or equal to\n * `<` - less than\n * `<=` - less than or equal to\n * `BETWEEN` - between\n * `IN` - in\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "equinix.fabric.port.bandwidth_rx.usage" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } } ], "result": { "name": "fabric_searchMetricsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getMetricByAssetIdResult" } }, "x-mcp-annotations": { "title": "Search Metrics", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchNetworks", "summary": "Search Networks", "description": "The API provides capability to search user's Fabric Network using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/NetworkFilter" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkSortCriteria" } } } ], "result": { "name": "fabric_searchNetworksResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "sort": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/name", "/type", "/uuid", "/state", "/scope", "/location/region", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } } }, "data": { "type": "array", "items": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Fabric_createNetworkResult_a6b74c70" }, { "$ref": "#/components/schemas/Fabric_createNetworkResult_88b5d778" } ], "description": "Network specification" } } }, "description": "List of networks", "x-fastmcp-top-level-schema": "NetworkSearchResponse" } }, "x-mcp-annotations": { "title": "Search Networks", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchOpticalConnect", "summary": "Search Optical Metro Connect Services", "description": "Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Optical Metro Connects" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_d83e72f9" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_d83e72f9" } } } } ], "description": "A single condition, or a group of conditions combined with logical OR." } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction.
ASC - ascending
DESC - descending\n", "default": "DESC" }, "property": { "enum": [ "/name", "/uuid", "/state", "/type", "/bandwidth", "/aSide/location/ibxCode", "/zSide/location/ibxCode", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } }, "description": "Sorting to apply to search results." } } } ], "result": { "name": "fabric_searchOpticalConnectResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_2f250477" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "OpticalConnectServiceSearchResponse" } }, "x-mcp-annotations": { "title": "Search Optical Metro Connect Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchPorts", "summary": "Search Ports", "description": "The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": true, "schema": { "$ref": "#/components/schemas/PortExpression" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortSortCriteria" } } } ], "result": { "name": "fabric_searchPortsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getPortsResult" } }, "x-mcp-annotations": { "title": "Search Ports", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchPrices", "summary": "Search Prices", "description": "Search prices by search criteria\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Prices" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/SearchExpression" } } ], "result": { "name": "fabric_searchPricesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "href": { "type": "string", "description": "An absolute URL that returns specified pricing data", "format": "url" }, "type": { "enum": [ "VIRTUAL_CONNECTION_PRODUCT", "IP_BLOCK_PRODUCT", "VIRTUAL_PORT_PRODUCT", "CLOUD_ROUTER_PRODUCT", "PRECISION_TIME_PRODUCT", "OPTICAL_CONNECT_PRODUCT" ], "type": "string", "description": "Product type" }, "code": { "type": "string", "description": "Equinix-assigned product code" }, "name": { "type": "string", "description": "Full product name" }, "description": { "type": "string", "description": "Product description" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "charges": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "MONTHLY_RECURRING", "NON_RECURRING" ], "type": "string", "description": "Price charge type" }, "price": { "minimum": 0.0, "type": "number", "description": "Offering price", "format": "double" } }, "description": "Price Charge" } }, "currency": { "type": "string", "description": "Product offering price currency" }, "termLength": { "enum": [ 1, 12, 24, 36, 60 ], "type": "integer", "description": "In months. No value or value of 1 means on-demand" }, "catgory": { "enum": [ "COUNTRY", "CUSTOMER" ], "type": "string", "description": "Price category" }, "connection": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Either uuid or rest of attributes are required", "format": "uuid" }, "type": { "enum": [ "EVPL_VC", "EPL_VC", "EC_VC", "IP_VC", "VD_CHAIN_VC", "ACCESS_EPL_VC", "EVPLAN_VC", "EPLAN_VC", "IPWAN_VC", "EVPTREE_VC", "EPTREE_VC", "IA_VC" ], "type": "string", "description": "Virtual Connection type" }, "bandwidth": { "minimum": 0.0, "type": "integer" }, "aSide": { "type": "object", "properties": { "accessPoint": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "type": { "enum": [ "VD", "SP", "COLO", "CLOUD_ROUTER", "CHAINGROUP", "NETWORK", "METAL_NETWORK" ], "type": "string", "description": "Virtual Connection access point type" }, "location": { "type": "object", "properties": { "metroCode": { "type": "string" }, "ibx": { "type": "string" } } }, "port": { "type": "object", "properties": { "settings": { "type": "object", "properties": { "buyout": { "type": "boolean", "default": false } } } } } } } } }, "zSide": { "type": "object", "properties": { "accessPoint": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "type": { "enum": [ "VD", "SP", "COLO", "CLOUD_ROUTER", "CHAINGROUP", "NETWORK", "METAL_NETWORK" ], "type": "string", "description": "Virtual Connection access point type" }, "location": { "type": "object", "properties": { "metroCode": { "type": "string" }, "ibx": { "type": "string" } } }, "port": { "type": "object", "properties": { "settings": { "type": "object", "properties": { "buyout": { "type": "boolean", "default": false } } } } }, "profile": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } }, "bridge": { "type": "object", "properties": { "package": { "type": "object", "properties": { "code": { "enum": [ "REGIONAL", "GLOBAL" ], "type": "string", "description": "Virtual Connection bridge package code" } } } } } } } } }, "geoScope": { "enum": [ "CANADA", "CONUS", "JAPAN", "UK", "AUSTRALIA", "BRAZIL", "SWITZERLAND", "EU" ], "type": "string", "description": "Geographic boundary types" } }, "description": "Virtual Connection Product configuration" }, "ipBlock": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Either uuid or rest of attributes are required", "format": "uuid" }, "type": { "enum": [ "IPv4", "IPv6" ], "type": "string", "description": "IP Block type" }, "prefixLength": { "type": "integer" }, "location": { "type": "object", "properties": { "metroCode": { "type": "string" }, "ibx": { "type": "string" } } } }, "description": "IP Block Product configuration" }, "router": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier assigned to the Cloud Router", "format": "uuid" }, "location": { "type": "object", "properties": { "metroCode": { "type": "string" }, "ibx": { "type": "string" } } }, "package": { "type": "object", "properties": { "code": { "enum": [ "LAB", "BASIC", "STANDARD", "ADVANCED", "PREMIUM" ], "type": "string", "description": "Cloud Router code" } }, "description": "Cloud Router package" } }, "description": "Cloud Router Product configuration" }, "port": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier assigned to the virtual port. Either the uuid or the remaining attributes must be supplied.", "format": "uuid" }, "type": { "enum": [ "XF_PORT" ], "type": "string", "description": "Port type." }, "location": { "type": "object", "properties": { "ibx": { "type": "string", "description": "Code assigned to the Equinix International Business Exchange (IBX) data center from which the port is ordered.
The port might be in a different location." } }, "description": "Geographic data for the port." }, "lag": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Parameter showing whether LAG configuration is mandatory. The default is false.", "default": false } }, "description": "Link aggregation group (LAG) preferences and settings." }, "physicalPortsQuantity": { "type": "integer", "description": "Number of physical ports requested. The defaults is 1.", "default": 1 }, "bandwidth": { "type": "integer", "description": "Aggregated data transfer capacity, expressed as follows
-> Mbps, megabits (1 million bits) per second
-> Gbps, gigabits (1 billion bits) per second
Bandwidth must be divisible by physicalPortsQuantity." }, "redundancy": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Parameter showing whether redundancy is mandatory. The default is false.", "default": false } }, "description": "Specifications for redundant connections, which improve service continuity by routing traffic to secondary ports when primary ports are unavailable.
Redundancy increases resilience and boosts site reliability scores." }, "connectivitySource": { "type": "object", "properties": { "type": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Type of connectivity. COLO, colocation; BMMR, building meet-me room. The default is COLO.
A building meet-me room (BMMR) is a room within the same building where an Equinix IBX customer can connect with a non-Equinix IBX customer.", "default": "COLO" } }, "description": "Physical or virtual port that houses the connection." }, "serviceType": { "enum": [ "MSP", "EPL" ], "type": "string", "description": "Port service type. The default is managed-service provider (MSP).", "default": "MSP" }, "settings": { "type": "object", "properties": { "buyout": { "type": "boolean", "description": "Buyout (true) or standard (false) configuration of the port at this access point.
Buyout ports offer free, unlimited connections. Standard ports do not. The default is false.", "default": false } }, "description": "Port configuration." }, "package": { "type": "object", "properties": { "code": { "type": "string", "description": "Virtual port package code", "example": "STANDARD, UNLIMITED or UNLIMITED_PLUS" } }, "description": "Virtual Port Package" }, "serviceCode": { "type": "string", "description": "Port service code." } }, "description": "Preferences and settings for a virtual port connected to an internet service provider (ISP) or other Equinix platform entity." }, "timeService": { "type": "object", "properties": { "type": { "enum": [ "NTP", "PTP" ], "type": "string", "description": "Precision Time Service Type refers to the corresponding Protocol." }, "package": { "$ref": "#/components/schemas/PrecisionTimePackageRequest" }, "connection": { "type": "object", "properties": { "aSide": { "type": "object", "properties": { "accessPoint": { "type": "object", "properties": { "location": { "type": "object", "properties": { "metroCode": { "type": "string" }, "ibx": { "type": "string" } } } }, "description": "Time Service Price Connection Access Point configuration" } }, "description": "Time Service Price Connection ASide configuration" } }, "description": "Time Service Price Connection configuration" } }, "description": "Time Service Product configuration" }, "opticalConnect": { "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Optical Connect type.", "example": "OC" }, "bandwidth": { "minimum": 0.0, "type": "integer", "description": "Bandwidth in Mbps", "example": 1000 }, "pathType": { "enum": [ "PROTECTED", "UNPROTECTED", "DUAL_DIVERSE" ], "type": "string", "description": "Optical Connect Port Path type." }, "connectionDestinationType": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Destination Port connectivity type" }, "aSide": { "type": "object", "properties": { "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX identifier", "example": "SV1" } }, "description": "Optical Connect Location" } }, "description": "Optical Connection ASide configuration" }, "zSide": { "type": "object", "properties": { "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX identifier", "example": "SV1" } }, "description": "Optical Connect Location" } }, "description": "Optical Connection ZSide configuration" } }, "description": "Optical Metro Connect Port Product configuration" } ] } } } }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "x-fastmcp-top-level-schema": "PriceSearchResponse" } }, "x-mcp-annotations": { "title": "Search Prices", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchRouteAggregationRules", "summary": "Search Route Aggregation Rules", "description": "This API provides capability to search Route Aggregation Rules\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregation Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeAggregationId", "description": "Route Aggregations UUID", "required": true, "schema": { "type": "string", "description": "Route Aggregations UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/RouteAggregationRulesFilter" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteAggregationRuleSortCriteria" } } } ], "result": { "name": "fabric_searchRouteAggregationRulesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_f30043a6" }, "description": "List of route aggregation rules" } }, "x-fastmcp-top-level-schema": "RouteAggregationRulesSearchResponse" } }, "x-mcp-annotations": { "title": "Search Route Aggregation Rules", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchRouteAggregations", "summary": "Search Route Aggregations", "description": "This API provides capability to search Route Aggregations\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Aggregations" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/SearchFilter" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteAggregationSortCriteria" } } } ], "result": { "name": "fabric_searchRouteAggregationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Aggregation URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION", "BGP_IPv6_PREFIX_AGGREGATION" ], "type": "string", "description": "Route Aggregation type" }, "uuid": { "type": "string", "description": "Route Aggregation identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "name": { "type": "string", "example": "My-direct-route-1" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "change": { "$ref": "#/components/schemas/Change_28881cd4" }, "connectionsCount": { "type": "integer", "example": 0 }, "rulesCount": { "type": "integer", "example": 0 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" }, "href": { "type": "string", "description": "Project URI", "format": "uri" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } }, "description": "List of Route Aggregations" } }, "x-fastmcp-top-level-schema": "RouteAggregationsSearchResponse" } }, "x-mcp-annotations": { "title": "Search Route Aggregations", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchRouteFilterRules", "summary": "Search Route Filter Rules", "description": "This API provides capability to search Route Filter Rules\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filter Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routeFilterId", "description": "Route Filters UUID", "required": true, "schema": { "type": "string", "description": "Route Filters UUID", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/RouteFilterRulesFilter" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteFilterRuleSortCriteria" } } } ], "result": { "name": "fabric_searchRouteFilterRulesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_ef249c5d" }, "description": "List of route filter rules" } }, "x-fastmcp-top-level-schema": "RouteFilterRulesSearchResponse" } }, "x-mcp-annotations": { "title": "Search Route Filter Rules", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchRouteFilters", "summary": "Search Route Filters", "description": "This API provides capability to search Route Filters\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Route Filters" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/SearchFilter" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteFilterSortCriteria" } } } ], "result": { "name": "fabric_searchRouteFiltersResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Route filter URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER", "BGP_IPv6_PREFIX_FILTER" ], "type": "string", "description": "Route Filter type" }, "uuid": { "type": "string", "description": "Route filter identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "name": { "type": "string", "example": "My-direct-route-1" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "change": { "$ref": "#/components/schemas/Change_2554fe61" }, "notMatchedRuleAction": { "enum": [ "ALLOW", "DENY" ], "type": "string" }, "connectionsCount": { "type": "integer", "example": 0 }, "rulesCount": { "type": "integer", "example": 0 }, "project": { "$ref": "#/components/schemas/Project_812bd497" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } }, "description": "List of route filters" } }, "x-fastmcp-top-level-schema": "RouteFiltersSearchResponse" } }, "x-mcp-annotations": { "title": "Search Route Filters", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchRouterActions", "summary": "Search Route Table Actions", "description": "This API provides capability to search route table actions for a given cloud router\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_91361e81" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_91361e81" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/connection/name", "/type" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchRouterActionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getCloudRouterActionsResult" } }, "x-mcp-annotations": { "title": "Search Route Table Actions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchServiceProfiles", "summary": "Search Service Profiles", "description": "Search service profiles by search criteria\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "viewPoint", "description": "flips view between buyer and seller representation", "required": false, "schema": { "enum": [ "aSide", "zSide" ], "type": "string", "default": "aSide", "description": "flips view between buyer and seller representation" } }, { "name": "filter", "required": false, "schema": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/Filter_0688d4ee" }, { "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/components/schemas/Filter_0688d4ee" } } } } ] } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/name", "/state", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchServiceProfilesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_listServiceProfilesResult" } }, "x-mcp-annotations": { "title": "Search Service Profiles", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchServiceTokens", "summary": "Search Service Tokens", "description": "The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Tokens" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "offset", "required": false, "schema": { "type": "number", "description": "offset" } }, { "name": "limit", "description": "number of records to fetch", "required": false, "schema": { "type": "number", "description": "number of records to fetch" } }, { "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ServiceTokenSearchExpression" } }, { "name": "pagination", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } } ], "result": { "name": "fabric_searchServiceTokensResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getServiceTokensResult" } }, "x-mcp-annotations": { "title": "Search Service Tokens", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchStreamAssets", "summary": "Search Stream Assets", "description": "This API provides capability to search stream assets\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_8d567a14" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_8d567a14" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/uuid", "/streamUuid" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/uuid" } } } } } ], "result": { "name": "fabric_searchStreamAssetsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream Asset URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "streamUuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "d4b8e7a2-f3b1-4576-a4a9-1366a63df171" }, "type": { "type": "string", "description": "Asset type", "example": "XF_PORT" }, "metricsEnabled": { "type": "boolean", "description": "enable metric", "example": true }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHED", "DETACHED", "DETACHING", "FAILED" ], "type": "string", "description": "asset status" }, "projectId": { "type": "string", "description": "project ic", "example": 123 } }, "description": "Stream object" }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "SearchStreamAssetResponse" } }, "x-mcp-annotations": { "title": "Search Stream Assets", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchStreamSubscriptions", "summary": "Search Stream Subscriptions", "description": "This API provides capability to search stream subscriptions\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": true, "schema": { "required": [ "and" ], "type": "object", "properties": { "and": { "minItems": 1, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_29e7c5f3" }, { "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/components/schemas/AndItem_29e7c5f3" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_25cdebca" } } ], "result": { "name": "fabric_searchStreamSubscriptionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_4194e588" } }, "x-fastmcp-top-level-schema": "SearchStreamSubscriptionResponse" } }, "x-mcp-annotations": { "title": "Search Stream Subscriptions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchStreams", "summary": "Search Streams", "description": "This API provides capability to search streams\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "required": [ "and" ], "type": "object", "properties": { "and": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_394410d0" }, { "type": "object", "properties": { "or": { "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_394410d0" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/Sort_25cdebca" } } ], "result": { "name": "fabric_searchStreamsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_e2b21d81" } }, "x-fastmcp-top-level-schema": "SearchStreamResponse" } }, "x-mcp-annotations": { "title": "Search Streams", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_searchTimeServices", "summary": "Search Time Services", "description": "The API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_14a4cfa9" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_14a4cfa9" } } } } ] } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "$ref": "#/components/schemas/PaginationRequest" } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/name", "/uuid", "/state", "/type", "/package/code", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } } } } ], "result": { "name": "fabric_searchTimeServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "type": "array", "items": { "title": "precisionTimeServiceResponse", "required": [ "uuid", "href", "type", "state", "package" ], "type": "object", "properties": { "href": { "type": "string", "description": "Precision Time Service URI.", "format": "uri" }, "type": { "enum": [ "NTP", "PTP" ], "type": "string", "description": "Precision Time Service type refers to the corresponding protocol." }, "name": { "type": "string", "description": "Precision Time Service Name." }, "uuid": { "type": "string", "description": "Precision Time Service UUID.", "format": "uuid" }, "state": { "enum": [ "CANCELLED", "CANCELLING", "CONFIGURING", "CONFIGURING_FAILED", "DRAFT", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "PROVISIONED", "PROVISIONING", "PROVISIONING_FAILED", "REPROVISIONING", "REPROVISIONING_FAILED" ], "type": "string", "description": "Precision Time Service Status." }, "operation": { "type": "object", "properties": { "operationalStatus": { "enum": [ "UP", "DOWN", "DEGRADED" ], "type": "string", "description": "time service operational status" } }, "description": "time service operational data" }, "package": { "$ref": "#/components/schemas/PrecisionTimePackagePostResponse" }, "connections": { "$ref": "#/components/schemas/Connections_73eaa6a1" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_b8d452c8" }, "ntpAdvancedConfiguration": { "$ref": "#/components/schemas/NtpAdvancedConfiguration" }, "ptpAdvancedConfiguration": { "$ref": "#/components/schemas/PtpAdvancedConfiguration" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "order": { "$ref": "#/components/schemas/PrecisionTimeOrder" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Precision Time Service Response Schema." }, "description": "Data returned from the API call." } }, "x-fastmcp-top-level-schema": "ServiceSearchResponse" } }, "x-mcp-annotations": { "title": "Search Time Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_serviceProfileEnvironmentAction", "summary": "Create Service Profile Environment Action", "description": "This API provides capability to perform actions on a service profile environment, such as validating an activation key.Beta\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } }, { "name": "environmentId", "description": "Provider Environment Reference", "required": true, "schema": { "type": "string", "description": "Provider Environment Reference" } }, { "name": "type", "description": "Environment action type", "required": true, "schema": { "enum": [ "VALIDATE_ACTIVATION_KEY" ], "type": "string", "description": "Environment action type", "example": "VALIDATE_ACTIVATION_KEY" } }, { "name": "keyDetails", "description": "Activation Key Details Beta", "required": true, "schema": { "$ref": "#/components/schemas/KeyDetails" } } ], "result": { "name": "fabric_serviceProfileEnvironmentActionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "href": { "type": "string", "description": "Environment action URI", "format": "uri" }, "type": { "enum": [ "VALIDATE_ACTIVATION_KEY" ], "type": "string", "description": "Environment action type", "example": "VALIDATE_ACTIVATION_KEY" }, "uuid": { "type": "string", "description": "Equinix-assigned action identifier", "format": "uuid", "example": "3a58dd05-f46d-4b1d-a154-2e85c396ea62" }, "state": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string", "description": "Environment action state. ACTIVE - already used , INACTIVE - not used", "example": "ACTIVE" }, "keyDetails": { "$ref": "#/components/schemas/KeyDetails" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Response from environment action Beta", "x-fastmcp-top-level-schema": "EnvironmentActionResponse" } }, "x-mcp-annotations": { "title": "Create Service Profile Environment Action", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_submitIpBlock", "summary": "Create IP Block", "description": "Submits new Equinix owned or customer owned IP Block request\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "IP Blocks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "required": true, "schema": { "enum": [ "IPV4_IP_BLOCK", "IPV6_IP_BLOCK" ], "type": "string", "x-enum-varnames": [ "IPV4_IP_BLOCK", "IPV6_IP_BLOCK" ] } }, { "name": "project", "required": true, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "project id" } } } }, { "name": "location", "required": false, "schema": { "required": [ "metroCode" ], "type": "object", "properties": { "metroHref": { "type": "string", "description": "Metro URL path for the linked resource", "example": "https://api.equinix.com/fabric/v4/metros/WA" }, "metroCode": { "pattern": "^[A-Z]{2}$", "type": "string", "example": "WA" } } } }, { "name": "account", "required": false, "schema": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "account number" } } } }, { "name": "order", "required": false, "schema": { "type": "object", "properties": { "purchaseOrderNumber": { "type": [ "string", "null" ], "description": "Purchase order number" }, "orderNumber": { "type": [ "string", "null" ], "description": "Order Number" }, "orderLine": { "type": [ "string", "null" ], "description": "Order Line Number" } } } }, { "name": "regulations", "required": false, "schema": { "$ref": "#/components/schemas/Regulations" } }, { "name": "prefixLength", "description": "IpBlockPrefix length", "required": false, "schema": { "maximum": 128.0, "minimum": 1.0, "type": "integer", "description": "IpBlockPrefix length" } }, { "name": "prefix", "description": "CIDR prefix", "required": false, "schema": { "type": "string", "description": "CIDR prefix" } } ], "result": { "name": "fabric_submitIpBlockResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteIpBlockByIdResult" } }, "x-mcp-annotations": { "title": "Create IP Block", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateAppDomainByUuid", "summary": "Update Domain", "description": "This API provides capability to update user's Domain\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Domains" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appDomainId", "description": "App Domain UUID", "required": true, "schema": { "type": "string", "description": "App Domain UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } }, { "name": "body", "description": "App Domain Update Request", "required": true, "schema": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DataItem_034e7d0f" }, "description": "App Domain Update Request" } } ], "result": { "name": "fabric_updateAppDomainByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppDomainResult" } }, "x-mcp-annotations": { "title": "Update Domain", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateAppLinkByUuid", "summary": "Update Link", "description": "This API provides capability to update user's Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "body", "description": "App Link Update Request", "required": true, "schema": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DataItem_6bc185be" }, "description": "App Link Update Request" } } ], "result": { "name": "fabric_updateAppLinkByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppLinkResult" } }, "x-mcp-annotations": { "title": "Update Link", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateAppServiceAttachmentToAppLink", "summary": "Update Service Attachment for Link", "description": "This API provides ability to update the App Service attachment to App Link\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Links" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appLinkId", "description": "App Link UUID", "required": true, "schema": { "type": "string", "description": "App Link UUID", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914" } }, { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "body", "description": "App Service attachment Update Request", "required": true, "schema": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "operation type applied to the resource" }, "path": { "enum": [ "/destinationIp" ], "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter", "x-go-type": "json.RawMessage" } }, "description": "App Link change operation data" }, "description": "App Service attachment Update Request" } } ], "result": { "name": "fabric_updateAppServiceAttachmentToAppLinkResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_attachAppServiceToAppLinkResult" } }, "x-mcp-annotations": { "title": "Update Service Attachment for Link", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateAppServiceByUuid", "summary": "Update Service", "description": "This API provides capability to update user's Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appServiceId", "description": "App Service UUID", "required": true, "schema": { "type": "string", "description": "App Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "body", "description": "App Service Update Request", "required": true, "schema": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DataItem_0e6dd2e7" }, "description": "App Service Update Request" } } ], "result": { "name": "fabric_updateAppServiceByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppServiceResult" } }, "x-mcp-annotations": { "title": "Update Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateAppSubscriptionByUuid", "summary": "Update Subscription", "description": "This API provides capability to update user's Subscription\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Application Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "appSubscriptionId", "description": "App Subscription UUID", "required": true, "schema": { "type": "string", "description": "App Subscription UUID", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3" } }, { "name": "body", "description": "App Subscription Update Request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DataItem_01b53787" }, "description": "App Subscription Update Request" } } ], "result": { "name": "fabric_updateAppSubscriptionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createAppSubscriptionResult" } }, "x-mcp-annotations": { "title": "Update Subscription", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateCloudRouterByUuid", "summary": "Update Router", "description": "This API provides capability to update user's Cloud Router\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Cloud Routers" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "body", "description": "Fabric Cloud Router Update Request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DataItem_150a893e" }, "description": "Fabric Cloud Router Update Request" } } ], "result": { "name": "fabric_updateCloudRouterByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createCloudRouterResult_0cce220a" } }, "x-mcp-annotations": { "title": "Update Router", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateConnectionByUuid", "summary": "Update Connection by ID", "description": "Update Connection by ID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Connections" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connectionId", "description": "Connection UUID", "required": true, "schema": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "body", "description": "Connection Update Request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Data_c55f2d51" }, "description": "Connection Update Request" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } } ], "result": { "name": "fabric_updateConnectionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createConnectionResult" } }, "x-mcp-annotations": { "title": "Update Connection by ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateExchangeServiceById", "summary": "Update Internet Exchange Service", "description": "The API provides capability to update Internet Exchange Service\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Internet Exchange Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "exchangeServiceId", "description": "Internet Exchange Service UUID", "required": true, "schema": { "type": "string", "description": "Internet Exchange Service UUID", "format": "uuid", "example": "a8ba52de-faae-43b5-b0b1-6904d37ee011" } }, { "name": "body", "required": true, "schema": { "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add" ], "type": "string", "description": "the operation to be performed" }, "path": { "type": "string", "description": "### A JSON Pointer path.\n * `/name` - Name of the Internet Exchange Service\n * `/description` - Description of the Internet Exchange Service\n * `routingProtocol/macAddress` - MAC Address\n * `routingProtocol/bgpIpv4/domainName` - Domain Name for BGP IPv4\n * `routingProtocol/bgpIpv4/asSet` - AS Set for BGP IPv4\n * `routingProtocol/bgpIpv4/md5AuthKey` - MD5 Auth Key for BGP IPv4\n * `routingProtocol/bgpIpv4/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv4\n * `routingProtocol/bgpIpv4/ipPrefixes` - IP Prefixes for BGP IPv4\n * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv4\n * `routingProtocol/bgpIpv6/domainName`- Domain Name for BGP IPv6\n * `routingProtocol/bgpIpv6/asSet`- AS Set for BGP IPv6\n * `routingProtocol/bgpIpv6/md5AuthKey` - MD5 Auth Key for BGP IPv6\n * `routingProtocol/bgpIpv6/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv6\n * `routingProtocol/bgpIpv6/ipPrefixes` - IP Prefixes for BGP IPv6\n * `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv6\n" }, "value": { "description": "value to replace with" } }, "description": "Replace attribute value or sub-resource in the existing model" } } } ], "result": { "name": "fabric_updateExchangeServiceByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createExchangeServiceResult" } }, "x-mcp-annotations": { "title": "Update Internet Exchange Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateLoaByUuid", "summary": "Update Loa", "description": "The API provides capability to update Loa details by Loa ID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Loas" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "loaId", "description": "Loa UUID", "required": true, "schema": { "type": "string", "description": "Loa UUID", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" } }, { "name": "body", "required": true, "schema": { "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "Operation to be performed" }, "path": { "type": "string", "description": "### A JSON Pointer path.\n * `/name` - Name of the Loa\n * `/description` - Description of the Loa\n * `/requestor/email` - Email of the requestor contact\n * `/requestor/orgName` - Organization name of the requestor\n * `/issuer/email` - Email of the issuer contact\n * `/issuer/orgName` - Organization name of the issuer\n * `/demarcationPoint/patchPanelId` - Patch Panel Identifier\n * `/demarcationPoint/patchPanelPortA` - Patch Panel Port A\n * `/demarcationPoint/patchPanelPortB` - Patch Panel Port B\n * `/demarcationPoint/connectorType` - Connector Type\n * `/demarcationPoint/cageUniqueSpaceId` - Cage Unique Space Identifier\n * `/expirationDateTime` - Expiration date and time of the Loa\n * `/location/ibxCode` - IBX code of the Eligible location\n" }, "value": { "description": "New value for updated parameter" } }, "description": "Replace attribute value or sub-resource in the existing model" } } } ], "result": { "name": "fabric_updateLoaByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createLoaResult" } }, "x-mcp-annotations": { "title": "Update Loa", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateNetworkByUuid", "summary": "Update Network By ID", "description": "This API provides capability to update user's Fabric Network\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Networks" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "networkId", "description": "Network UUID", "required": true, "schema": { "type": "string", "description": "Network UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "body", "description": "Fabric Network Update Request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DataItem_66587e9f" }, "description": "Fabric Network Update Request" } } ], "result": { "name": "fabric_updateNetworkByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createNetworkResult_32127b47" } }, "x-mcp-annotations": { "title": "Update Network By ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updatePortByUuid", "summary": "Update Port by ID", "description": "Update Port by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Ports" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "portId", "description": "Port UUID", "required": true, "schema": { "type": "string", "description": "Port UUID", "format": "uuid" } }, { "name": "body", "description": "Port Update Request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Data_8223e945" }, "description": "Port Update Request" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } } ], "result": { "name": "fabric_updatePortByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_getPortsResult" } }, "x-mcp-annotations": { "title": "Update Port by ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateServiceProfileByUuid", "summary": "Update Service Profile", "description": "Update Service Profile by UUID\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Profiles" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceProfileId", "description": "Service Profile UUID", "required": true, "schema": { "type": "string", "description": "Service Profile UUID", "format": "uuid" } }, { "name": "body", "required": true, "schema": { "$ref": "#/components/schemas/Data_00e43f43" } } ], "result": { "name": "fabric_updateServiceProfileByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceProfileResult" } }, "x-mcp-annotations": { "title": "Update Service Profile", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateServiceTokenByUuid", "summary": "Update Token By ID", "description": "This API provides capability to update user's Service Token\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Service Tokens" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceTokenId", "description": "Service Token UUID", "required": true, "schema": { "type": "string", "description": "Service Token UUID", "format": "uuid" } }, { "name": "body", "description": "Service Token Update Request", "required": true, "schema": { "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/expirationDateTime" }, "value": { "description": "new value for updated parameter" } }, "description": "Service Token change operation data" }, "description": "Service Token Update Request" } }, { "name": "dryRun", "description": "option to verify that API calls will succeed", "required": false, "schema": { "type": "boolean", "default": false, "description": "option to verify that API calls will succeed" } } ], "result": { "name": "fabric_updateServiceTokenByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createServiceTokenResult" } }, "x-mcp-annotations": { "title": "Update Token By ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_updateStreamAlertRuleByUuid", "summary": "Update Stream Alert Rule", "description": "This API provides capability to update a user's stream alert rule\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Alert Rules" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "alertRuleId", "description": "Stream Alert Rule UUID", "required": true, "schema": { "type": "string", "description": "Stream Alert Rule UUID", "format": "uuid", "example": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15" } }, { "name": "name", "description": "Customer-provided stream name", "required": true, "schema": { "type": "string", "description": "Customer-provided stream name" } }, { "name": "type", "required": true, "schema": { "enum": [ "METRIC_ALERT" ], "type": "string" } }, { "name": "metricSelector", "required": true, "schema": { "required": [ "include" ], "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "example": "equinix.fabric.metro.sv_da.latency" }, "description": "Stream alert rule filtered by metric name" } } } }, { "name": "resourceSelector", "required": true, "schema": { "$ref": "#/components/schemas/ResourceSelector_b024e7f3" } }, { "name": "detectionMethod", "required": true, "schema": { "$ref": "#/components/schemas/DetectionMethod_5a5caddf" } }, { "name": "description", "description": "Customer-provided stream description", "required": false, "schema": { "type": "string", "description": "Customer-provided stream description" } }, { "name": "enabled", "description": "Stream alert rule enabled status", "required": false, "schema": { "type": "boolean", "description": "Stream alert rule enabled status", "default": true } } ], "result": { "name": "fabric_updateStreamAlertRuleByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamAlertRulesResult" } }, "x-mcp-annotations": { "title": "Update Stream Alert Rule", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_updateStreamAssetByUuid", "summary": "Attach Asset", "description": "This API provides capability to attach an asset to a stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "assetId", "description": "Stream Asset UUID", "required": true, "schema": { "type": "string", "description": "Stream Asset UUID", "format": "uuid", "example": "757400f8-d360-11e9-bb65-2a2ae2dbcce6" } }, { "name": "asset", "description": "asset", "required": true, "schema": { "enum": [ "ports", "connections", "routers", "metros", "organizations", "projects", "companyProfiles" ], "type": "string", "description": "asset" } }, { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "metricsEnabled", "description": "enable metric", "required": false, "schema": { "type": "boolean", "description": "enable metric", "default": false, "example": false } } ], "result": { "name": "fabric_updateStreamAssetByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteStreamAssetByUuidResult" } }, "x-mcp-annotations": { "title": "Attach Asset", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_updateStreamByUuid", "summary": "Update Stream", "description": "This API provides capability to update user's stream\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "name", "description": "Customer-provided stream name", "required": true, "schema": { "type": "string", "description": "Customer-provided stream name" } }, { "name": "description", "description": "Customer-provided stream description", "required": false, "schema": { "type": "string", "description": "Customer-provided stream description" } } ], "result": { "name": "fabric_updateStreamByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamsResult" } }, "x-mcp-annotations": { "title": "Update Stream", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_updateStreamDevice", "summary": "Attach Network Edge Device Interfaces", "description": "This API provides capability to attach a Network Edge Device and its interfaces to a stream. The provided interfaces list is the complete desired set: interfaces not in the list are detached, new interfaces are attached. An empty or absent interfaces list detaches all currently attached interfaces. metricsEnabled must be true when interfaces are provided.\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Streams" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "deviceId", "description": "Network Edge Device UUID", "required": true, "schema": { "type": "string", "description": "Network Edge Device UUID", "format": "uuid", "example": "8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d" } }, { "name": "metricsEnabled", "description": "enable metric. Must be true when interfaces are provided", "required": false, "schema": { "type": "boolean", "description": "enable metric. Must be true when interfaces are provided", "default": false, "example": true } }, { "name": "interfaces", "description": "Complete desired set of Network Edge Device interfaces attached to the stream. Interfaces not in the list are detached; an empty or absent list detaches all interfaces.\n", "required": false, "schema": { "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Network Edge Device interface identifier", "format": "int32", "example": 5 } }, "description": "Network Edge Device interface" }, "description": "Complete desired set of Network Edge Device interfaces attached to the stream. Interfaces not in the list are detached; an empty or absent list detaches all interfaces.\n" } } ], "result": { "name": "fabric_updateStreamDeviceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_deleteStreamAssetByUuidResult" } }, "x-mcp-annotations": { "title": "Attach Network Edge Device Interfaces", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_updateStreamSubscriptionByUuid", "summary": "Update Subscription", "description": "This API provides capability to update user's Stream Subscriptions\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Stream Subscriptions" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "streamId", "description": "Stream UUID", "required": true, "schema": { "type": "string", "description": "Stream UUID", "format": "uuid", "example": "657400f8-d360-11e9-bb65-2a2ae2dbcce5" } }, { "name": "subscriptionId", "description": "Stream Subscription UUID", "required": true, "schema": { "type": "string", "description": "Stream Subscription UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "type", "required": true, "schema": { "enum": [ "STREAM_SUBSCRIPTION" ], "type": "string" } }, { "name": "name", "description": "Customer-provided stream subscription name", "required": true, "schema": { "type": "string", "description": "Customer-provided stream subscription name" } }, { "name": "sink", "description": "Create Stream destination", "required": true, "schema": { "$ref": "#/components/schemas/Sink_80fea9cf" } }, { "name": "description", "description": "Customer-provided stream subscription description", "required": false, "schema": { "type": "string", "description": "Customer-provided stream subscription description" } }, { "name": "enabled", "description": "Stream subscription enabled status", "required": false, "schema": { "type": "boolean", "description": "Stream subscription enabled status", "example": true } }, { "name": "filters", "required": false, "schema": { "type": "object", "properties": { "and": { "maxItems": 8, "type": "array", "items": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_d06bfc44" }, { "type": "object", "properties": { "or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_d06bfc44" } } } } ] } } } } }, { "name": "metricSelector", "required": false, "schema": { "$ref": "#/components/schemas/MetricSelector" } }, { "name": "eventSelector", "required": false, "schema": { "$ref": "#/components/schemas/MetricSelector" } } ], "result": { "name": "fabric_updateStreamSubscriptionByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Fabric_createStreamSubscriptionsResult" } }, "x-mcp-annotations": { "title": "Update Subscription", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_updateTimeServicesById", "summary": "Update Time Service by ID", "description": "The API provides capability to update Precision Time Service by service id\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Precision Time Services" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Precision Time Service UUID", "required": true, "schema": { "type": "string", "description": "Precision Time Service UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "body", "required": true, "schema": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "enum": [ "/name", "/package/code", "/ipv4", "/ntpAdvancedConfiguration", "/ptpAdvancedConfiguration" ], "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter" } }, "description": "Fabric Precision Timing change operation data" } } } ], "result": { "name": "fabric_updateTimeServicesByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/PrecisionTimeServiceResponse" } }, "x-mcp-annotations": { "title": "Update Time Service by ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "fabric_validateConnections", "summary": "Validate Connection", "description": "This API provides capability to validate by auth key\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Connections" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "description": "Filters", "required": false, "schema": { "$ref": "#/components/schemas/Filter_a9592b4b" } } ], "result": { "name": "fabric_validateConnectionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Additional information" }, "data": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Equinix-assigned connection identifier" }, "bandwidth": { "maximum": 100000.0, "minimum": 0.0, "type": "integer", "description": "Connection bandwidth in Mbps" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_03b2b702" }, "aSide": { "$ref": "#/components/schemas/ASide_cdc3f780" }, "zSide": { "$ref": "#/components/schemas/ASide_cdc3f780" } }, "description": "Validate Connection specification" }, "description": "Connection response data" } }, "description": "ValidateResponse", "x-fastmcp-top-level-schema": "ConnectionResponse" } }, "x-mcp-annotations": { "title": "Validate Connection", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fabric_validateRoutingProtocol", "summary": "Validate Subnet", "description": "This API provides capability to validate all subnets associated with any connection in the given FCR\n\nPart of the Equinix Fabric API family (fabric). Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1.", "tags": [ { "name": "fabric" }, { "name": "Routing Protocols" }, { "name": "interconnection" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "routerId", "description": "Cloud Router UUID", "required": true, "schema": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, { "name": "filter", "description": "Filters", "required": false, "schema": { "$ref": "#/components/schemas/Filter_a9592b4b" } } ], "result": { "name": "fabric_validateRoutingProtocolResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Additional information" } }, "description": "ValidateResponse", "x-fastmcp-top-level-schema": "ValidateSubnetResponse" } }, "x-mcp-annotations": { "title": "Validate Subnet", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "fetch", "summary": "Fetch Equinix Doc", "description": "Fetch the full markdown content of an Equinix documentation page by URL. Use URLs returned from the 'search' tool.", "tags": [ { "name": "docs" } ], "paramStructure": "by-name", "params": [ { "name": "url", "description": "The URL of the documentation page (e.g., from search results)", "required": true, "schema": { "type": "string", "description": "The URL of the documentation page (e.g., from search results)" } } ], "result": { "name": "fetchResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "result": { "type": "string" } }, "required": [ "result" ], "type": "object", "x-fastmcp-wrap-result": true } } }, { "name": "find_docs", "summary": "Find Equinix Docs by Filename", "description": "Find Equinix documentation by filename", "tags": [ { "name": "docs" } ], "paramStructure": "by-name", "params": [ { "name": "query", "required": true, "schema": { "type": "string" } } ], "result": { "name": "find_docsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "result": { "type": "string" } }, "required": [ "result" ], "type": "object", "x-fastmcp-wrap-result": true } } }, { "name": "getprojects_getAllProjects", "summary": "To retrieve projects of a root organization", "description": "To get projects associated to a root organization based on the user permissions\n\nPart of the Equinix Project API family (getprojects). Retrieve Equinix projects.", "tags": [ { "name": "getprojects" }, { "name": "Project" }, { "name": "projects" } ], "paramStructure": "by-name", "params": [ { "name": "includePermissions", "description": "whether to include the user permissions on the project resource", "required": false, "schema": { "type": "boolean", "default": false, "example": false, "description": "whether to include the user permissions on the project resource" } }, { "name": "includeInbox", "description": "Whether to include the projects with inbox classification or not", "required": false, "schema": { "type": "boolean", "default": false, "example": false, "description": "Whether to include the projects with inbox classification or not" } }, { "name": "limit", "description": "Limits the number of returned results", "required": false, "schema": { "maximum": 100.0, "minimum": 1.0, "type": "integer", "default": 20, "example": 50, "description": "Limits the number of returned results" } }, { "name": "offset", "description": "Offset from which start returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Offset from which start returned results" } } ], "result": { "name": "getprojects_getAllProjectsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "pagination": { "allOf": [ { "title": "Pagination", "type": "object", "properties": { "offset": { "type": "integer", "description": "the data items would be fetched from the user input offset point", "example": 0 }, "limit": { "type": "integer", "description": "max number of data items that can be fetched in current request", "default": 20, "example": 20 }, "total": { "type": "integer", "description": "total number of data items available", "example": 50 }, "previous": { "type": "string", "description": "Url to fetch previous set of paginated data", "example": "/resourceManager/v2/organizations/search?orgLike=Micro&offset=0&limit=20" }, "next": { "type": "string", "description": "Url to fetch next set of paginated data", "example": "/resourceManager/v2/organizations/search?orgLike=Micro&offset=10&limit=40" } } }, { "type": "object", "properties": { "previous": { "example": "/resourceManager/v2/projects?offset=0&limit=20" }, "next": { "example": "/resourceManager/v2/projects?offset=10&limit=20" } } } ] }, "data": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Project id", "example": "1234" }, "projectName": { "type": "string", "description": "Project name", "example": "Default project" }, "inboxResource": { "type": "boolean", "description": "Inbox project or not", "example": true }, "parentOrganizationId": { "type": "string", "description": "Parent organization id", "example": "1234" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource Labels as JSON key, value pairs", "example": { "application": "Network Edge" } }, "silentProject": { "type": "boolean", "description": "Whether the returned project is a SILENT project or not", "example": true }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "Permission", "example": [ "resourcemanager.project.read", "fabric.l3connection.create" ] }, "resourceType": { "type": "string", "description": "Resource type", "example": "L2_CONNECTION" } } }, "description": "Available user permissions on the project resource, if requested by query param" } } } } }, "x-fastmcp-top-level-schema": "ProjectV2PaginatedResponse" } }, "x-mcp-annotations": { "title": "To retrieve projects of a root organization", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_accountAgreements", "summary": "Lists account agreement statuses", "description": "Account agreements for given account number.\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Accounts" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Number of account to search by", "required": true, "schema": { "pattern": "^\\d+$", "type": "string", "example": "100013200", "description": "Number of account to search by" } }, { "name": "ibx", "description": "Agreement IBX", "required": true, "schema": { "pattern": "^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$", "type": "string", "example": "WA1", "description": "Agreement IBX" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_accountAgreementsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" }, "type": { "enum": [ "MCA_GTC" ], "type": "string", "description": "MCA - Master Country Agreement, GTC - Global Terms & Conditions", "example": "MCA_GTC" }, "valid": { "type": "boolean", "example": true } } } } }, "x-fastmcp-top-level-schema": "AccountAgreementsPage" } }, "x-mcp-annotations": { "title": "Lists account agreement statuses", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_createEquinixInternetAccess", "summary": "Creates Equinix Internet Access Service", "description": "By passing in the appropriate options, you can create Equinix Internet Access Service product. The entire request either succeeds or fails. In case of failure all the changes in the system are rolled back, so the system gets back to its stated before submitting the request\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "SINGLE_PORT - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide\nDUAL_PORT - Internet Access Service supported with two redundant Connections originating from two redundant AccessPoints on the Aside and terminating to two redundant Internet Routers on the ZSide\n", "required": true, "schema": { "$ref": "#/components/schemas/Type_de450d9f" } }, { "name": "useCase", "description": "Service use case\n", "required": true, "schema": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "description": "Service use case\n", "example": "MAIN" } }, { "name": "name", "description": "Name of the service instance\n", "required": true, "schema": { "type": "string", "description": "Name of the service instance\n", "example": "WebServers" } }, { "name": "bandwidth", "description": "Service bandwidth in Mbps\n", "required": true, "schema": { "type": "integer", "description": "Service bandwidth in Mbps\n", "example": 10000 } }, { "name": "connections", "description": "Collection of service connections\n", "required": true, "schema": { "maxItems": 2, "minItems": 1, "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, { "required": [ "aSide", "type" ], "type": "object", "properties": { "type": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "description": "Connection type. IA_C - internet access connection on dedicated port; IA_VC - internet access virtual connection on Fabric Port, Virtual Device, Bare Metal, etc." }, "name": { "type": "string", "description": "Connection name\n", "example": "MainInternetAccess" }, "description": { "type": "string", "description": "Connection name\n", "example": "MainInternetAccess" }, "aSide": { "required": [ "accessPoint" ], "type": "object", "properties": { "accessPoint": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "COLO", "VD" ], "type": "string", "description": "Type of access point. SUBNET is reserved for future use. Gateway, Fabric Gateway; IGW, internet gateway; COLO, colocation; VD, virtual device; SP, service profile." } }, "description": "Access point object" } } } } } ] }, "description": "Collection of service connections\n" } }, { "name": "routingProtocols", "description": "Collection of routing protocols\n", "required": true, "schema": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "DIRECT", "STATIC", "BGP" ], "type": "string" }, "name": { "type": "string", "description": "Name of the routing protocol instance.\n", "example": "WebServers Routes" }, "description": { "type": "string", "description": "Description of the routing protocol instance\n", "example": "Routes to customer facing web servers\n" } } } ] }, "description": "Collection of routing protocols\n" } }, { "name": "account", "required": true, "schema": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Billing account number\n", "example": "2-57689234" } } } }, { "name": "tags", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "description", "description": "Description of the service instance\n", "required": false, "schema": { "type": "string", "description": "Description of the service instance\n", "example": "Customer facing web servers\n" } }, { "name": "minBandwidthCommit", "description": "Service min bandwidth commit in Mbps\n", "required": false, "schema": { "minimum": 0.0, "type": "integer", "description": "Service min bandwidth commit in Mbps\n", "example": 500 } }, { "name": "billing", "description": "Type of billing\n", "required": false, "schema": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "description": "Type of billing\n", "default": "FIXED" } }, { "name": "draft", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "order", "required": false, "schema": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, { "type": "object", "properties": { "contacts": { "type": "array", "items": { "allOf": [ { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "TECHNICAL", "ORDERING", "RESELLING", "BILLING" ], "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "timezone": { "type": "string" }, "notes": { "type": "string" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME", "CUSTOMER_BUSINESS_HOURS", "NOT_AVAILABLE" ], "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "EMAIL", "PHONE", "MOBILE", "SECONDARY_EMAIL" ], "type": "string" }, "value": { "type": "string" }, "notes": { "type": "string" } } } } } }, { "type": "object", "properties": { "registeredUser": { "type": "string", "description": "Identifies (e.g., userName) a registered user. If a registered user is specified, then firstName/lastName need not be provided\n", "example": "123232" } } } ] } }, "draft": { "type": "boolean", "default": false }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrder_5185db24" }, "referenceNumber": { "type": "string", "example": "239384723943" }, "signature": { "$ref": "#/components/schemas/Signature_82273560" } } } ] } }, { "name": "project", "required": false, "schema": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Customer Resource Hierarchy Project identifier\n", "example": "7348" } } } } ], "result": { "name": "internetaccess_createEquinixInternetAccessResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Internetaccess_createEquinixInternetAccessResult" } }, "x-mcp-annotations": { "title": "Creates Equinix Internet Access Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "internetaccess_deleteEquinixInternetAccess", "summary": "Deletes Equinix Internet Access Service", "description": "Delete Equinix Internet Access product by passing the id of the service. \nThe entire request either succeeds or fails.\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Service identifier", "required": true, "schema": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } }, { "name": "dryRun", "description": "Setting this parameter to true will perform only request validation without actually deleting the service", "required": false, "schema": { "type": "boolean", "description": "Setting this parameter to true will perform only request validation without actually deleting the service", "example": true } } ], "result": { "name": "internetaccess_deleteEquinixInternetAccessResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Internetaccess_createEquinixInternetAccessResult" } }, "x-mcp-annotations": { "title": "Deletes Equinix Internet Access Service", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getCabinets", "summary": "Get list of available Cabinets", "description": "Only Cabinets available for EIA should be returned\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Cabinets" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "cage.spaceId", "description": "Cage space ID", "required": false, "schema": { "type": "string", "example": "CH2:03:00603", "description": "Cage space ID" } }, { "name": "location.ibx", "description": "IBX code for given location", "required": false, "schema": { "type": "string", "example": "CH2", "description": "IBX code for given location" } }, { "name": "account.accountNumber", "description": "Account number", "required": false, "schema": { "type": "string", "example": "123111232", "description": "Account number" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "maximum": 250.0, "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getCabinetsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "allOf": [ { "required": [ "spaceId" ], "type": "object", "properties": { "spaceId": { "type": "string", "example": "AT1:03:034720:0102" } } }, { "required": [ "account", "cage", "location", "number", "patchPanelsCount" ], "type": "object", "properties": { "number": { "type": "string", "example": "Cabinet Number One" }, "patchPanelsCount": { "type": "integer", "example": 123 }, "cage": { "required": [ "spaceId" ], "type": "object", "properties": { "spaceId": { "type": "string", "example": "AT1:03:034720" } } }, "location": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "12345678" } } } } } ] } } }, "x-fastmcp-top-level-schema": "CabinetsPage" } }, "x-mcp-annotations": { "title": "Get list of available Cabinets", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getCages", "summary": "Get list of available Cages", "description": "Only Cages available for EIA should be returned\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Cages" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "location.ibx", "description": "IBX code for given location", "required": true, "schema": { "type": "string", "example": "CH2", "description": "IBX code for given location" } }, { "name": "account.accountNumber", "description": "Account number", "required": true, "schema": { "type": "string", "example": "123111232", "description": "Account number" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "maximum": 250.0, "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getCagesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "allOf": [ { "required": [ "spaceId" ], "type": "object", "properties": { "spaceId": { "type": "string", "example": "AT1:03:034720" } } }, { "required": [ "account", "cabinetsCount", "location", "number" ], "type": "object", "properties": { "number": { "type": "string", "example": "Cage Number One" }, "cabinetsCount": { "type": "integer", "example": 123 }, "location": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "12345678" } } } } } ] } } }, "x-fastmcp-top-level-schema": "CagesPage" } }, "x-mcp-annotations": { "title": "Get list of available Cages", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getConnectionServices", "summary": "Get list of available connection services", "description": "Only Connection Services available for EIA should be returned\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Connection Services" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "mediaTypes.connectorTypes.locations.ibx", "description": "IBX Code", "required": true, "schema": { "type": "string", "example": "SG1", "description": "IBX Code" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getConnectionServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "example": "Connection Service name" }, "mediaTypes": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "example": "Media Type name" }, "connectorTypes": { "type": "array", "items": { "required": [ "name", "optionalPorts", "requiredPorts" ], "type": "object", "properties": { "name": { "type": "string", "example": "Connector Type name" }, "requiredPorts": { "maximum": 2.0, "minimum": 1.0, "type": "integer", "format": "int32", "example": 1 }, "optionalPorts": { "maximum": 1.0, "minimum": 0.0, "type": "integer", "format": "int32", "example": 0 }, "locations": { "type": "array", "items": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "CH2" } } } } } } } } } } } } } }, "x-fastmcp-top-level-schema": "ConnectionServicesPage" } }, "x-mcp-annotations": { "title": "Get list of available connection services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getCustomerRouteConfigurations", "summary": "Customer Route Configuration API Endpoint", "description": "Get customer route configurations\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Attribute Eligibility" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "useCase", "description": "Use case", "required": true, "schema": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN", "description": "Use case" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } }, { "name": "type", "description": "Type of Equinix Internet Access Service", "required": false, "schema": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "example": "SINGLE_PORT", "description": "Type of Equinix Internet Access Service" } }, { "name": "routingProtocol.type", "description": "Type of Routing Protocol", "required": false, "schema": { "enum": [ "BGP", "DIRECT", "STATIC" ], "type": "string", "example": "BGP", "description": "Type of Routing Protocol" } } ], "result": { "name": "internetaccess_getCustomerRouteConfigurationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "example": "SINGLE_PORT" }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN" }, "routingProtocol": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "BGP", "STATIC", "DIRECT" ], "type": "string" }, "ipv4": { "type": "object", "properties": { "customerRoute": { "type": "object", "properties": { "importPolicy": { "enum": [ "PI", "PA" ], "type": "string", "example": "PA" }, "prefixLength": { "type": "integer", "example": 28 } } }, "peering": { "type": "object", "properties": { "vrrpEnabled": { "type": "boolean" } } } } }, "ipv6": { "type": "object", "properties": { "customerRoute": { "type": "object", "properties": { "importPolicy": { "enum": [ "PI", "PA" ], "type": "string", "example": "PA" }, "prefixLength": { "type": "integer", "example": 28 } } }, "peering": { "type": "object", "properties": { "vrrpEnabled": { "type": "boolean" } } } } } }, "description": "One of properties ipv4 and ipv6 will be always present in routing protocol object." } } } } }, "x-fastmcp-top-level-schema": "CustomerRouteConfigurationPage" } }, "x-mcp-annotations": { "title": "Customer Route Configuration API Endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getDedicatedBandwidthConfigurations", "summary": "Dedicated Bandwidth Attribute Eligibility API Endpoint", "description": "Get dedicated bandwidth configurations\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Attribute Eligibility" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "useCase", "description": "Use case", "required": true, "schema": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN", "description": "Use case" } }, { "name": "connection.aside.accessPoint.port.physicalPort.speed", "description": "ASide access point physical port speed (Mbps), i.e. 1000, 10000, 100000", "required": false, "schema": { "type": "integer", "description": "ASide access point physical port speed (Mbps), i.e. 1000, 10000, 100000" } }, { "name": "billing", "description": "Billing type", "required": false, "schema": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "example": "BURST_BASED", "description": "Billing type" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getDedicatedBandwidthConfigurationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "bandwidth", "connection", "useCase" ], "type": "object", "properties": { "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN" }, "bandwidth": { "type": "integer", "description": "in Mbps", "example": 150000 }, "minBandwidthCommit": { "type": "integer", "description": "in Mbps", "example": 150000 }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "example": "BURST_BASED" }, "connection": { "type": "object", "properties": { "aside": { "type": "object", "properties": { "accessPoint": { "type": "object", "properties": { "port": { "type": "object", "properties": { "physicalPortsQuantity": { "type": "integer", "example": 2 }, "physicalPort": { "type": "object", "properties": { "speed": { "type": "integer", "description": "physical port speed in Mbps" } } } } } } } } } } } } } } }, "x-fastmcp-top-level-schema": "DedicatedBandwidthConfigurationPage" } }, "x-mcp-annotations": { "title": "Dedicated Bandwidth Attribute Eligibility API Endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getDedicatedPortDefaultConfigurationsPage", "summary": "Dedicated port default configurations API Endpoint", "description": "Get dedicated port default configurations\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Attribute Eligibility" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connection.aside.accessPoint.location.ibx", "description": "ASide access point location IBX", "required": true, "schema": { "type": "string", "example": "WA1", "description": "ASide access point location IBX" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getDedicatedPortDefaultConfigurationsPageResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "billing", "connection" ], "type": "object", "properties": { "type": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "example": "SINGLE_PORT" }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN" }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "example": "FIXED" }, "bandwidth": { "type": "integer", "description": "in Mbps", "example": 15 }, "minBandwidthCommit": { "type": "integer", "description": "in Mbps" }, "connection": { "type": "object", "properties": { "aside": { "type": "object", "properties": { "accessPoint": { "type": "object", "properties": { "location": { "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } }, "port": { "type": "object", "properties": { "physicalPortsQuantity": { "type": "integer", "example": 1 }, "physicalPort": { "type": "object", "properties": { "speed": { "type": "integer", "description": "in Mbps", "example": 1000 }, "interface": { "type": "object", "properties": { "type": { "enum": [ "1G SMF", "10G SMF", "100G SMF" ], "type": "string", "example": "1G SMF" } } }, "demarcationPoint": { "type": "object", "properties": { "mediaType": { "type": "string", "example": "Single-Mode Fiber" } } } } } } } } } } } } }, "routingProtocol": { "type": "object", "properties": { "type": { "enum": [ "BGP", "STATIC", "DIRECT" ], "type": "string", "example": "DIRECT" }, "ipv4": { "type": "object", "properties": { "customerRoute": { "type": "object", "properties": { "importPolicy": { "enum": [ "PI", "PA" ], "type": "string", "example": "PA" }, "prefixLength": { "type": "integer", "example": 29 } } } } }, "ipv6": { "type": "object", "properties": { "customerRoute": { "type": "object", "properties": { "importPolicy": { "enum": [ "PI", "PA" ], "type": "string", "example": "PA" }, "prefixLength": { "type": "integer", "example": 29 } } } } } } } } } } }, "x-fastmcp-top-level-schema": "DedicatedPortDefaultConfigurationsPage" } }, "x-mcp-annotations": { "title": "Dedicated port default configurations API Endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getEquinixInternetAccessServiceDetails", "summary": "Get Equinix Internet Access Service details", "description": "Get Equinix Internet Access Service details.\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceUuid", "description": "Service identifier", "required": true, "schema": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } ], "result": { "name": "internetaccess_getEquinixInternetAccessServiceDetailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "account", "bandwidth", "billing", "change", "changeLog", "connections", "draft", "href", "links", "name", "order", "routingProtocols", "state", "type", "useCase", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Internet access URI", "format": "uri", "example": "https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec" }, "uuid": { "type": "string", "description": "Equinix-assigned internet access identifier", "format": "uuid", "example": "df043001-bf0a-446b-a48f-bcdcca68a9f3" }, "type": { "$ref": "#/components/schemas/Type_de450d9f" }, "name": { "type": "string", "description": "Name of the service\nThis name should only contain spaces, the characters \"_\", \"-\", letters or numbers. The name cannot\nstart or end with a \"-\". This name can have only maximum of 24 characters\n", "example": "Internet Access" }, "description": { "type": "string", "description": "Description of the service", "example": "Internet access service" }, "bandwidth": { "minimum": 1000.0, "type": "integer", "description": "Bandwidth of the service in Mbps", "format": "int64", "example": 1000 }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "description": "Billing type of service", "example": "FIXED" }, "state": { "enum": [ "DRAFT", "PENDING", "PROVISIONING", "ACTIVE", "INACTIVE", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string" }, "draft": { "type": "boolean", "description": "Describes if the service is a draft", "example": false }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "description": "use case of the service", "example": "MAIN" }, "change": { "required": [ "href", "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "type": { "enum": [ "SERVICE_CREATION", "SERVICE_UPDATE", "SERVICE_DELETION" ], "type": "string", "description": "Change Type" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "connections": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsItem_076d1d44" } }, "routingProtocols": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingProtocolsItem" } }, "account": { "$ref": "#/components/schemas/Account_0c8b1638" }, "project": { "$ref": "#/components/schemas/Project_ddb4509d" }, "order": { "$ref": "#/components/schemas/Order_68fbde57" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] }, "links": { "$ref": "#/components/schemas/Links_8561166d" } }, "x-fastmcp-top-level-schema": "ServiceDetailsResponse" } }, "x-mcp-annotations": { "title": "Get Equinix Internet Access Service details", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getEquinixInternetAccessServices", "summary": "Get Equinix Internet Access Services", "description": "Get Equinix Internet Access Services that match specified criteria.\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "Search result offset", "required": false, "schema": { "type": "number", "example": 20, "description": "Search result offset" } }, { "name": "limit", "description": "Search result limit", "required": false, "schema": { "type": "number", "example": 35, "description": "Search result limit" } }, { "name": "sort", "description": "Search result sorting", "required": false, "schema": { "pattern": "^([-]?[\\/][a-z]+[,]?)+$", "type": "string", "example": "/name,-/type", "description": "Search result sorting" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "type": "array", "items": { "required": [ "operator", "property", "values" ], "type": "object", "properties": { "property": { "type": "string" }, "operator": { "enum": [ "" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } } } } } } ], "result": { "name": "internetaccess_getEquinixInternetAccessServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "required": [ "data", "pagination", "sort" ], "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "sort": { "$ref": "#/components/schemas/Sort_c782f755" }, "data": { "type": "array", "items": { "required": [ "account", "bandwidth", "billing", "changeLog", "connections", "draft", "href", "links", "name", "project", "routingProtocols", "state", "type", "useCase", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Internet access URI", "format": "uri", "example": "https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec" }, "uuid": { "type": "string", "description": "Equinix-assigned internet access identifier", "format": "uuid", "example": "df043001-bf0a-446b-a48f-bcdcca68a9f3" }, "type": { "$ref": "#/components/schemas/Type_de450d9f" }, "name": { "type": "string", "description": "Name of the service\nThis name should only contain spaces, the characters \"_\", \"-\", letters or numbers. The name cannot\nstart or end with a \"-\". This name can have only maximum of 24 characters\n", "example": "Internet Access" }, "description": { "type": "string", "description": "Description of the service", "example": "Internet access service" }, "bandwidth": { "minimum": 1000.0, "type": "integer", "description": "Bandwidth of the service in Mbps", "format": "int64", "example": 1000 }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "description": "Billing type of service", "example": "FIXED" }, "state": { "enum": [ "DRAFT", "PENDING", "PROVISIONING", "ACTIVE", "INACTIVE", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string" }, "draft": { "type": "boolean", "description": "Describes if the service is a draft", "example": false }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "description": "use case of the service", "example": "MAIN" }, "change": { "required": [ "href", "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string", "format": "uuid" }, "type": { "enum": [ "SERVICE_CREATION", "SERVICE_UPDATE", "SERVICE_DELETION" ], "type": "string", "description": "Change Type" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "connections": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsItem_076d1d44" } }, "routingProtocols": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RoutingProtocolsItem" } }, "account": { "$ref": "#/components/schemas/Account_0c8b1638" }, "project": { "$ref": "#/components/schemas/Project_ddb4509d" }, "order": { "$ref": "#/components/schemas/Order_68fbde57" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] }, "links": { "$ref": "#/components/schemas/Links_8561166d" } } } } }, "x-fastmcp-top-level-schema": "SearchResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get Equinix Internet Access Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getIbx", "summary": "Returns requested IBX where EIA is available", "description": "Get IBX\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Product Availability" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "ibx", "description": "Ibx code", "required": true, "schema": { "type": "string", "example": "WA1", "description": "Ibx code" } }, { "name": "service.connection.type", "description": "Service connection type (physical, virtual)", "required": false, "schema": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "description": "Service connection type (physical, virtual)" } }, { "name": "connection.aside.accessPoint.type", "description": "Service connection access point type. When not provided, COLO type is used by default.", "required": false, "schema": { "enum": [ "COLO", "VD" ], "type": "string", "description": "Service connection access point type. When not provided, COLO type is used by default." } } ], "result": { "name": "internetaccess_getIbxResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "example": "https://api.equinix.com/internetAccess/ibxs/WA1" }, "countryCode": { "type": "string", "example": "PL" }, "countryName": { "type": "string", "example": "Poland" }, "region": { "enum": [ "APAC", "EMEA", "AMER" ], "type": "string", "example": "EMEA" }, "metroCode": { "type": "string", "example": "WA" }, "metroName": { "type": "string", "example": "Warsaw" }, "ibx": { "type": "string", "description": "IBX data center code", "example": "WA1" }, "geoCoordinates": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "type": "number", "example": 53.55 }, "longitude": { "type": "number", "example": 9.95 } } } }, "description": "IBX object", "x-fastmcp-top-level-schema": "Ibx" } }, "x-mcp-annotations": { "title": "Returns requested IBX where EIA is available", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getIbxs", "summary": "Returns IBXs where EIA is available", "description": "Get IBXs\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Product Availability" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "service.connection.type", "description": "Service connection type (physical, virtual)", "required": true, "schema": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "example": "IA_C", "description": "Service connection type (physical, virtual)" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } }, { "name": "connection.aside.accessPoint.type", "description": "Service connection access point type. When not provided, COLO type is used by default.", "required": false, "schema": { "enum": [ "COLO", "VD" ], "type": "string", "description": "Service connection access point type. When not provided, COLO type is used by default." } } ], "result": { "name": "internetaccess_getIbxsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "example": "https://api.equinix.com/internetAccess/ibxs/WA1" }, "countryCode": { "type": "string", "example": "PL" }, "countryName": { "type": "string", "example": "Poland" }, "region": { "enum": [ "APAC", "EMEA", "AMER" ], "type": "string", "example": "EMEA" }, "metroCode": { "type": "string", "example": "WA" }, "metroName": { "type": "string", "example": "Warsaw" }, "ibx": { "type": "string", "description": "IBX data center code", "example": "WA1" }, "geoCoordinates": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "type": "number", "example": 53.55 }, "longitude": { "type": "number", "example": 9.95 } } } }, "description": "IBX object" } } }, "x-fastmcp-top-level-schema": "IbxPage" } }, "x-mcp-annotations": { "title": "Returns IBXs where EIA is available", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getOperationalUnits", "summary": "List operational units", "description": "Returns list of operational units as JSON object list\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Operational Units" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "location.ibx", "description": "Operational Unit IBX code", "required": true, "schema": { "pattern": "^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$", "type": "string", "example": "SG1", "description": "Operational Unit IBX code" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getOperationalUnitsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "address", "location", "name" ], "type": "object", "properties": { "name": { "type": "string", "example": "Equinix (Netherlands) B.V., Registration No: 24429748" }, "address": { "required": [ "address1" ], "type": "object", "properties": { "address1": { "type": "string", "description": "Address Line 1", "example": "Aleje Jerozolimskie 65/79" }, "address2": { "type": "string", "description": "Address Line 2" }, "city": { "type": "string", "description": "City name", "example": "Warsaw" }, "countryCode": { "type": "string", "description": "Country code", "example": "PL" }, "country": { "type": "string", "description": "Country name", "example": "Poland" }, "zipCode": { "type": "string", "description": "Zip code", "example": "00-697" } } }, "location": { "required": [ "ibx", "metroCode" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" }, "metroCode": { "type": "string", "example": "WA" } } } } } } }, "x-fastmcp-top-level-schema": "OperationalUnitPage" } }, "x-mcp-annotations": { "title": "List operational units", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getOrder", "summary": "Returns EIA Order details", "description": "Returns Order details\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "EIA Order" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "orderUUID", "description": "UUID of the checked order", "required": true, "schema": { "type": "string", "format": "uuid", "example": "d27c0f84-f1da-498e-95c0-f3d3ae02d16d", "description": "UUID of the checked order" } } ], "result": { "name": "internetaccess_getOrderResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "allOf": [ { "allOf": [ { "allOf": [ { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } } ] }, { "type": "object", "properties": { "type": { "enum": [ "NEW", "AMENDMENT" ], "type": "string", "example": "AMENDMENT" }, "contacts": { "type": "array", "items": { "allOf": [ { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, { "required": [ "registeredUser", "type" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "TECHNICAL", "ORDERING", "RESELLING", "BILLING" ], "type": "string" }, "registeredUser": { "type": "string", "description": "Identifies (e.g., userName) a registered user. If a registered user is specified, then firstName/lastName need not be provided\n", "example": "123232" } } } ] } }, "draft": { "type": "boolean", "default": false }, "links": { "$ref": "#/components/schemas/Links_8561166d" }, "purchaseOrder": { "allOf": [ { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, { "required": [ "number" ], "type": "object", "properties": { "number": { "type": "string", "example": "92374933" }, "type": { "enum": [ "STANDARD_PURCHASE_ORDER", "BLANKET_PURCHASE_ORDER" ], "type": "string" } } } ] }, "referenceNumber": { "type": "string", "example": "239384723943" }, "signature": { "$ref": "#/components/schemas/Signature_82273560" }, "state": { "enum": [ "DRAFT", "PROCESSING", "AWAITING_SIGNATURE", "SIGNATURE_REJECTED", "SIGNATURE_EXPIRED", "COMPLETED", "FAILED" ], "type": "string" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4755022f" }, "tags": { "type": "array", "items": { "type": "string" } } } } ] }, { "required": [ "number" ], "type": "object", "properties": { "number": { "type": "string" } } } ], "x-fastmcp-top-level-schema": "OrderDetails" } }, "x-mcp-annotations": { "title": "Returns EIA Order details", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getPatchPanels", "summary": "Get list of available Patch Panels", "description": "Only Cages available for EIA should be returned\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Patch Panels" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "location.ibx", "description": "IBX code for given location", "required": true, "schema": { "type": "string", "example": "CH2", "description": "IBX code for given location" } }, { "name": "account.accountNumber", "description": "Account number", "required": true, "schema": { "type": "string", "example": "123111232", "description": "Account number" } }, { "name": "cage.spaceId", "description": "Cage space ID", "required": true, "schema": { "type": "string", "example": "CH2:03:00603", "description": "Cage space ID" } }, { "name": "cabinet.spaceId", "description": "Cabinet space ID", "required": true, "schema": { "type": "string", "example": "CH1:01:011201:0204", "description": "Cabinet space ID" } }, { "name": "mediaTypes.name", "description": "Media Type", "required": false, "schema": { "type": "string", "example": "SINGLE_MODE_FIBER", "description": "Media Type" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "maximum": 250.0, "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getPatchPanelsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "account", "availablePorts", "cabinet", "cage", "dedicatedMediaType", "location", "mediaTypes", "number", "ownedPorts", "prewired", "type" ], "type": "object", "properties": { "number": { "type": "string", "example": "PP:0325:1175941" }, "customerRefNumber": { "type": "string", "example": "ME1:01:040310:0422:RU34:49-72" }, "type": { "enum": [ "EQUINIX_PROVIDED", "CUSTOMER_PROVIDED", "PREWIRE_PANEL_INFRASTRUCTURE", "EQUINIX_INFRASTRUCTURE" ], "type": "string", "example": "EQUINIX_PROVIDED" }, "prewired": { "type": "boolean", "example": true }, "availablePortsCount": { "type": "integer", "example": 4 }, "availablePorts": { "type": "array", "items": { "type": "integer" }, "example": [ 2, 3, 4, 5 ] }, "ownedPortsCount": { "type": "integer", "example": 1 }, "ownedPorts": { "type": "array", "items": { "required": [ "ownershipType" ], "type": "object", "properties": { "number": { "type": "integer", "example": 1 }, "ownershipType": { "enum": [ "USED", "RESERVED" ], "type": "string", "example": "USED" }, "ownerType": { "enum": [ "LOA_REQUEST", "DIGITAL_LOA", "CROSS_CONNECT", "NETWORK_PORT", "METRO_CONNECT", "OTHER" ], "type": "string", "example": "CROSS_CONNECT" }, "ownerUuid": { "type": "number" } } } }, "mediaTypes": { "type": "array", "items": { "type": "string" }, "example": [ "CAT3", "CAT5e", "CAT6", "CAT6A", "CAT6a", "COAX", "OS1", "SINGLE_MODE_FIBER" ] }, "dedicatedMediaType": { "type": "string", "example": "MIXED" }, "cage": { "required": [ "spaceId" ], "type": "object", "properties": { "spaceId": { "type": "string", "example": "AT1:03:034720" } } }, "cabinet": { "required": [ "spaceId" ], "type": "object", "properties": { "spaceId": { "type": "string", "example": "AT1:03:034720:0102" } } }, "location": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "12345678" } } } } } } }, "x-fastmcp-top-level-schema": "PatchPanelsPage" } }, "x-mcp-annotations": { "title": "Get list of available Patch Panels", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getPortConfigurations", "summary": "Dedicated Port Attribute Eligibility API Endpoint", "description": "Get port configurations\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Attribute Eligibility" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connection.aside.accessPoint.port.location.ibx", "description": "ASide access point port location IBX", "required": true, "schema": { "pattern": "^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$", "type": "string", "example": "WA1", "description": "ASide access point port location IBX" } }, { "name": "useCase", "description": "Use case", "required": true, "schema": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN", "description": "Use case" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getPortConfigurationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "connection", "routingProtocol", "type", "useCase" ], "type": "object", "properties": { "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN" }, "type": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "example": "SINGLE_PORT" }, "routingProtocol": { "type": "object", "properties": { "ipv4": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } } }, "ipv6": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } } } } }, "connection": { "required": [ "aside" ], "type": "object", "properties": { "aside": { "required": [ "accessPoint" ], "type": "object", "properties": { "accessPoint": { "required": [ "port" ], "type": "object", "properties": { "port": { "required": [ "location", "physicalPort" ], "type": "object", "properties": { "location": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } }, "physicalPort": { "required": [ "demarcationPoint", "interface", "speed" ], "type": "object", "properties": { "speed": { "type": "integer", "description": "in Mbps", "example": 100000 }, "interface": { "type": "object", "properties": { "type": { "type": "string", "example": "100G SMF" } } }, "demarcationPoint": { "type": "object", "properties": { "mediaType": { "type": "string", "example": "Single-Mode Fiber" } } } } } } } } } } } } } } } } }, "x-fastmcp-top-level-schema": "PortConfigurationPage" } }, "x-mcp-annotations": { "title": "Dedicated Port Attribute Eligibility API Endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getPurchaseOrder", "summary": "Get specified purchase order", "description": "Returns single purchase order\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Purchase Orders" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Number of account to search by", "required": true, "schema": { "type": "string", "example": "100013200", "description": "Number of account to search by" } }, { "name": "number", "description": "purchase order number", "required": true, "schema": { "type": "string", "example": "PO-1234567", "description": "purchase order number" } } ], "result": { "name": "internetaccess_getPurchaseOrderResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "account", "amount", "categories", "currency", "draft", "locations", "number", "type" ], "type": "object", "properties": { "type": { "enum": [ "STANDARD_PURCHASE_ORDER", "BLANKET_PURCHASE_ORDER" ], "type": "string", "description": "Purchase order type" }, "number": { "type": "string", "description": "Purchase order number", "example": "10010" }, "account": { "type": "object", "properties": { "accountNumber": { "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "description": "Customer billing account number", "example": "123123" } } }, "categories": { "type": "array", "items": { "enum": [ "ALL_SERVICES", "INTERCONNECTION", "NETWORK", "POWER", "SPACE", "SMART_HANDS", "SERVICES" ], "type": "string" } }, "locations": { "type": "array", "items": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } } }, "amount": { "type": "number", "description": "Amount", "format": "double", "example": 10000.5 }, "startDate": { "type": "string", "description": "Start date in YYYY-MM-DD format", "format": "date" }, "endDate": { "type": "string", "description": "End date in YYYY-MM-DD format", "format": "date" }, "description": { "type": "string", "description": "Purchase order description", "example": "Purchase order desc" }, "draft": { "type": "boolean", "description": "Is draft", "format": "boolean", "example": false }, "status": { "enum": [ "DRAFT", "ACTIVE" ], "type": "string", "example": "DRAFT" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "x-fastmcp-top-level-schema": "PurchaseOrder" } }, "x-mcp-annotations": { "title": "Get specified purchase order", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getPurchaseOrders", "summary": "List purchase orders", "description": "List purchase orders\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Purchase Orders" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Number of account to search by", "required": true, "schema": { "type": "string", "example": "100013200", "description": "Number of account to search by" } }, { "name": "locations.ibx", "description": "IBX code", "required": false, "schema": { "type": "string", "example": "WA1", "description": "IBX code" } }, { "name": "category", "description": "product category", "required": false, "schema": { "enum": [ "ALL_SERVICES", "INTERCONNECTION", "SMART_HANDS", "POWER", "NETWORK", "SERVICES", "SPACE" ], "type": "string", "default": "INTERCONNECTION", "description": "product category" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getPurchaseOrdersResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "account", "amount", "categories", "currency", "draft", "locations", "number", "type" ], "type": "object", "properties": { "type": { "enum": [ "STANDARD_PURCHASE_ORDER", "BLANKET_PURCHASE_ORDER" ], "type": "string", "description": "Purchase order type" }, "number": { "type": "string", "description": "Purchase order number", "example": "10010" }, "account": { "type": "object", "properties": { "accountNumber": { "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "description": "Customer billing account number", "example": "123123" } } }, "categories": { "type": "array", "items": { "enum": [ "ALL_SERVICES", "INTERCONNECTION", "NETWORK", "POWER", "SPACE", "SMART_HANDS", "SERVICES" ], "type": "string" } }, "locations": { "type": "array", "items": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } } }, "amount": { "type": "number", "description": "Amount", "format": "double", "example": 10000.5 }, "startDate": { "type": "string", "description": "Start date in YYYY-MM-DD format", "format": "date" }, "endDate": { "type": "string", "description": "End date in YYYY-MM-DD format", "format": "date" }, "description": { "type": "string", "description": "Purchase order description", "example": "Purchase order desc" }, "draft": { "type": "boolean", "description": "Is draft", "format": "boolean", "example": false }, "status": { "enum": [ "DRAFT", "ACTIVE" ], "type": "string", "example": "DRAFT" }, "currency": { "$ref": "#/components/schemas/Currency" } } } } }, "x-fastmcp-top-level-schema": "PurchaseOrdersPage" } }, "x-mcp-annotations": { "title": "List purchase orders", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getRoutingConfigurations", "summary": "Routing Protocol Attribute Eligibility API Endpoint", "description": "Get routing protocol configurations\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Attribute Eligibility" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "useCase", "description": "Use case", "required": true, "schema": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN", "description": "Use case" } }, { "name": "type", "description": "Port type", "required": false, "schema": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "example": "SINGLE_PORT", "description": "Port type" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getRoutingConfigurationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "routingProtocol", "type", "useCase" ], "type": "object", "properties": { "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN" }, "type": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "example": "SINGLE_PORT" }, "routingProtocol": { "type": "object", "properties": { "type": { "enum": [ "BGP", "STATIC", "DIRECT" ], "type": "string", "example": "BGP" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_49af3f34" }, "ipv6": { "$ref": "#/components/schemas/Ipv4_49af3f34" } } } } } } }, "x-fastmcp-top-level-schema": "RoutingProtocolConfigurationPage" } }, "x-mcp-annotations": { "title": "Routing Protocol Attribute Eligibility API Endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getSignaturePolicies", "summary": "List signature policies", "description": "Returns list of signature policies as JSON object list\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Signature Policies" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } }, { "name": "location.countryCode", "description": "Country code", "required": false, "schema": { "type": "string", "example": "US", "description": "Country code" } } ], "result": { "name": "internetaccess_getSignaturePoliciesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "clickThroughAllowed", "location", "signature" ], "type": "object", "properties": { "signature": { "type": "object", "properties": { "types": { "type": "array", "items": { "enum": [ "WET", "DIGITAL" ], "type": "string", "example": "DIGITAL" } } } }, "clickThroughAllowed": { "type": "boolean", "example": true }, "location": { "required": [ "countryCode" ], "type": "object", "properties": { "countryCode": { "type": "string", "example": "PL" } } } } } } }, "x-fastmcp-top-level-schema": "SignaturePoliciesPage" } }, "x-mcp-annotations": { "title": "List signature policies", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getTermsAndConditions", "summary": "Retrieve terms and conditions", "description": "Returns Terms And Conditions as HTML text\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Terms and Conditions" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "account.accountNumber", "description": "Account number", "required": true, "schema": { "type": "string", "example": "123111232", "description": "Account number" } }, { "name": "location.ibx", "description": "IBX code for given location", "required": true, "schema": { "type": "string", "example": "CH2", "description": "IBX code for given location" } }, { "name": "connectivitySource.type", "description": "Connectivity source type", "required": true, "schema": { "enum": [ "COLO" ], "type": "string", "example": "COLO", "description": "Connectivity source type" } }, { "name": "product", "description": "Product", "required": true, "schema": { "enum": [ "IA_C", "IA_VC", "MC_C" ], "type": "string", "example": "IA_C", "description": "Product" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } }, { "name": "type", "description": "Agreement type", "required": false, "schema": { "enum": [ "TERMS_AND_CONDITIONS", "RENEWAL_TERMS", "PRICE_INCREASE_TERMS" ], "type": "string", "example": "TERMS_AND_CONDITIONS", "description": "Agreement type" } }, { "name": "language", "description": "2 letter ISO 639-1 language code", "required": false, "schema": { "maxLength": 2, "minLength": 2, "type": "string", "default": "en", "example": "en", "description": "2 letter ISO 639-1 language code" } } ], "result": { "name": "internetaccess_getTermsAndConditionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "account", "connectivitySource", "language", "location", "product", "text", "type", "version" ], "type": "object", "properties": { "text": { "type": "string", "example": "\r\n\t\r\n\t\r\n\t\r\n\t\r\n\t\r\n\t\t
\r\n\t\t\t1. INTRODUCTION\r\n\t\t\t

\r\n\t\t\tBy clicking to “Accept”..." }, "version": { "type": "string", "example": "a0F6w000000buYKEAY" }, "location": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "CH2" } } }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "12312312223" } } }, "connectivitySource": { "type": "object", "properties": { "type": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "example": "COLO" } } }, "type": { "enum": [ "TERMS_AND_CONDITIONS", "RENEWAL_TERMS", "PRICE_INCREASE_TERMS" ], "type": "string", "default": "TERMS_AND_CONDITIONS" }, "product": { "enum": [ "IA_C", "IA_VC", "MC_C" ], "type": "string" }, "language": { "type": "string", "example": "en" } } } } }, "x-fastmcp-top-level-schema": "TermsAndConditionsPage" } }, "x-mcp-annotations": { "title": "Retrieve terms and conditions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getVirtualBandwidthConfigurations", "summary": "Virtual Bandwidth Attribute Eligibility API Endpoint", "description": "Get virtual bandwidth configurations\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Attribute Eligibility" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "useCase", "description": "Use case", "required": true, "schema": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN", "description": "Use case" } }, { "name": "billing", "description": "Billing type", "required": false, "schema": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "example": "BURST_BASED", "description": "Billing type" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getVirtualBandwidthConfigurationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "bandwidth", "billing", "useCase" ], "type": "object", "properties": { "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN" }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "example": "FIXED" }, "bandwidth": { "type": "integer", "description": "in Mbps", "example": 150000 }, "minBandwidthCommit": { "type": "integer", "description": "in Mbps", "example": 150000 } } } } }, "x-fastmcp-top-level-schema": "VirtualBandwidthConfigurationPage" } }, "x-mcp-annotations": { "title": "Virtual Bandwidth Attribute Eligibility API Endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_getVirtualConnectionDefaultConfigurations", "summary": "Virtual Connection Default Configuration Attribute Eligibility API Endpoint", "description": "Get virtual connection default configurations\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Attribute Eligibility" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "connection.aside.accessPoint.location.ibx", "description": "Access point IBX code", "required": true, "schema": { "pattern": "^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$", "type": "string", "example": "WA1", "description": "Access point IBX code" } }, { "name": "connection.aside.accessPoint.location.metroCode", "description": "Access point Metro code", "required": false, "schema": { "type": "string", "description": "Access point Metro code" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_getVirtualConnectionDefaultConfigurationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "bandwidth", "billing", "connection", "routingProtocol", "type", "useCase" ], "type": "object", "properties": { "type": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "example": "SINGLE_PORT" }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "example": "MAIN" }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "example": "FIXED" }, "bandwidth": { "type": "integer", "description": "in Mbps" }, "minBandwidthCommit": { "type": "integer", "description": "in Mbps" }, "connection": { "required": [ "aside" ], "type": "object", "properties": { "aside": { "required": [ "accessPoint" ], "type": "object", "properties": { "accessPoint": { "required": [ "location" ], "type": "object", "properties": { "location": { "required": [ "metroCode" ], "type": "object", "properties": { "metroCode": { "type": "string", "example": "WA" }, "ibx": { "pattern": "^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$", "type": "string", "example": "WA1" } } } } } } } } }, "routingProtocol": { "required": [ "ipv4", "ipv6", "type" ], "type": "object", "properties": { "type": { "enum": [ "DIRECT", "STATIC", "BGP" ], "type": "string", "example": "DIRECT" }, "ipv4": { "required": [ "customerRoute" ], "type": "object", "properties": { "customerRoute": { "required": [ "importPolicy", "prefixLength" ], "type": "object", "properties": { "importPolicy": { "enum": [ "PI", "PA" ], "type": "string", "example": "PA" }, "prefixLength": { "type": "integer" } } } } }, "ipv6": { "required": [ "customerRoute" ], "type": "object", "properties": { "customerRoute": { "required": [ "importPolicy", "prefixLength" ], "type": "object", "properties": { "importPolicy": { "enum": [ "PI", "PA" ], "type": "string", "example": "PA" }, "prefixLength": { "type": "integer" } } } } } } } } } } }, "x-fastmcp-top-level-schema": "VirtualConnectionDefaultConfigurationPage" } }, "x-mcp-annotations": { "title": "Virtual Connection Default Configuration Attribute Eligibility API Endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_listAccounts", "summary": "Lists accounts available for user within IBX", "description": "List all accounts that are available for EIA ordering in a given IBX.\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Accounts" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "operationalUnits.ibxs.ibx", "description": "Operational Unit IBX code", "required": true, "schema": { "pattern": "^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$", "type": "string", "example": "SG1", "description": "Operational Unit IBX code" } }, { "name": "project.projectId", "description": "Customer Resource Hierarchy Project identifier, for future use, not applicable in EIA on dedicated port scenario", "required": false, "schema": { "type": "string", "example": "7348", "description": "Customer Resource Hierarchy Project identifier, for future use, not applicable in EIA on dedicated port scenario" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_listAccountsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "accountName", "accountNumber", "billing", "operationalUnits" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "100013200" }, "accountName": { "type": "string", "example": "Web Henderson" }, "billing": { "$ref": "#/components/schemas/Billing_5af391da" }, "operationalUnits": { "$ref": "#/components/schemas/OperationalUnits" }, "orgId": { "type": "string", "description": "Customer organization identifier", "example": "1232" }, "organizationName": { "type": "string", "description": "Customer organization name", "example": "Equinix, Inc." } } } } }, "x-fastmcp-top-level-schema": "AccountPage" } }, "x-mcp-annotations": { "title": "Lists accounts available for user within IBX", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_searchPrices", "summary": "Search EIA prices", "description": "Search Equinix Internet Access prices by criteria. Currency depends on the billing account. Internally prices are processed according to ISO 4217 standard. Prices are returned as numbers. If for any reason a product or its part is provided for free, then it will be listed in the response with a price of 0.\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Prices" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": true, "schema": { "required": [ "and" ], "type": "object", "properties": { "and": { "required": [ "items" ], "type": "array", "items": { "required": [ "operator", "property", "values" ], "type": "object", "properties": { "property": { "type": "string" }, "operator": { "enum": [ "" ], "type": "string" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" } } } } } } } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } } ], "result": { "name": "internetaccess_searchPricesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "category", "charges", "code", "currency", "href", "name", "summary", "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "An absolute URL that returns specified pricing data", "format": "url" }, "type": { "enum": [ "INTERNET_ACCESS_PRODUCT", "IP_BLOCK_PRODUCT" ], "type": "string", "description": "Product type" }, "code": { "type": "string", "description": "Equinix-assigned product code" }, "name": { "type": "string", "description": "Full product name" }, "description": { "type": "string", "description": "Product description" }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Customer billing account number.", "example": "2-57689234" } }, "description": "Customer billing account data. It must be validated to ensure that (1) it can be used for ordering in the source metro and (2) the user is permitted to access the data." }, "currency": { "$ref": "#/components/schemas/Currency" }, "category": { "enum": [ "COUNTRY", "CUSTOMER" ], "type": "string", "description": "Price category" }, "charges": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ChargesItem_9a3d62f8" }, { "type": "object", "properties": { "product": { "type": "object", "properties": { "type": { "enum": [ "INTERNET_ACCESS_PRODUCT", "IP_BLOCK_PRODUCT" ], "type": "string", "description": "Product type" }, "code": { "type": "string", "description": "Equinix-assigned product code.", "example": "EC00015.PROD" }, "name": { "type": "string", "description": "Full product name.", "example": "Internet Access Service Product" }, "description": { "type": "string", "description": "Product description.", "example": "Internet Access Service" } } } } } ], "description": "Price Charge" } }, "summary": { "required": [ "charges", "totalCharge" ], "type": "object", "properties": { "charges": { "type": "array", "items": { "$ref": "#/components/schemas/ChargesItem_9a3d62f8" } }, "totalCharge": { "required": [ "price" ], "type": "object", "properties": { "price": { "type": "number" } } } } }, "service": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier assigned to the service. Either the uuid or the remaining attributes must be supplied.", "format": "uuid", "example": "38a1eb68-4daf-4ef0-bd7f-6970727b6fc1" }, "type": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "description": "Service type. SINGLE_PORT - internet access with single connection; DUAL_PORT - internet access with two redundant connections." }, "bandwidth": { "type": "integer", "description": "Connection bandwidth (Mbps).", "format": "int32", "example": 100 }, "minBandwidthCommit": { "type": "integer", "description": "Minimum bandwidth commit (Mbps). Used in case of Burst Based billing.", "format": "int32", "example": 100 }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "description": "Billing type.", "default": "FIXED" }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string" }, "connection": { "required": [ "aSide", "type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier assigned to the connection. Either the uuid or the remaining attributes must be supplied.", "format": "uuid", "example": "38a1eb68-4daf-4ef0-bd7f-6970727b6fc1" }, "type": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "description": "Connection type. IA_C - internet access connection on dedicated port; IA_VC - internet access virtual connection on Fabric Port, Virtual Device, Bare Metal, etc." }, "aSide": { "required": [ "accessPoint" ], "type": "object", "properties": { "accessPoint": { "required": [ "location", "port", "type" ], "type": "object", "properties": { "type": { "enum": [ "COLO", "VD" ], "type": "string", "description": "Type of access point. SUBNET is reserved for future use. Gateway, Fabric Gateway; IGW, internet gateway; COLO, colocation; VD, virtual device; SP, service profile." }, "location": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "description": "Two-letter prefix for the ibx in which the IP block is located.", "example": "SV1" } }, "description": "Geographic data for the product." }, "port": { "required": [ "physicalPortQuantity" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "physicalPort": { "required": [ "speed" ], "type": "object", "properties": { "speed": { "type": "integer", "description": "Physical Port speed (Mbps) i.e. 1000, 10000, 100000", "format": "int32", "example": 1000 } } }, "physicalPortQuantity": { "minimum": 1.0, "type": "integer", "format": "int32" } }, "description": "Port associated with the connection." } }, "description": "A carrier-neutral network hub linking internet access providers." } }, "description": "A-side (subscriber) connection configuration." } } }, "routingProtocol": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "DIRECT", "STATIC", "BGP" ], "type": "string" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_a83cf05c" }, "ipv6": { "$ref": "#/components/schemas/Ipv4_a83cf05c" } } } }, "description": "Properties of this object can be used in search in form of JsonPointers unless speficied otherwise." }, "ipBlock": { "required": [ "location", "type" ], "properties": { "uuid": { "type": "string", "description": "Unique identifier assigned to the IP block.", "example": "70f3e0cb-4630-4ea8-88c8-31f9999345f7" }, "type": { "enum": [ "IA_IP_BLOCK" ], "type": "string", "description": "IP Block type." }, "location": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "description": "Two-letter prefix for the ibx in which the IP block is located.", "example": "SV1" } }, "description": "Geographic data for the product." }, "ipv4": { "$ref": "#/components/schemas/IpBlock_a884a7c2" }, "ipv6": { "$ref": "#/components/schemas/IpBlock_a884a7c2" } }, "description": "Configuration of the IP block to which the specified connections belong. An IP block is a set of sequential internet protocol (IP) addresses issued to a single entity, such as an internet service provider (ISP). Properties of this object can be used in search in form of JsonPointers, one of ipv4 or ipv6 is required." } } } }, "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" } }, "x-fastmcp-top-level-schema": "PriceSearchResponse" } }, "x-mcp-annotations": { "title": "Search EIA prices", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccess_singleAccount", "summary": "Returns a single account", "description": "Account object for given account number.\n\nPart of the Equinix Internet Access API family (internetaccess). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccess" }, { "name": "Accounts" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Number of account to search by", "required": true, "schema": { "pattern": "^\\d+$", "type": "string", "example": "100013200", "description": "Number of account to search by" } } ], "result": { "name": "internetaccess_singleAccountResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "accountName", "accountNumber", "billing", "operationalUnits" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "100013200" }, "accountName": { "type": "string", "example": "Web Henderson" }, "billing": { "$ref": "#/components/schemas/Billing_5af391da" }, "operationalUnits": { "$ref": "#/components/schemas/OperationalUnits" }, "orgId": { "type": "string", "description": "Customer organization identifier", "example": "1232" }, "organizationName": { "type": "string", "description": "Customer organization name", "example": "Equinix, Inc." } }, "x-fastmcp-top-level-schema": "AccountDetails" } }, "x-mcp-annotations": { "title": "Returns a single account", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccessv2_createEquinixInternetAccessv2", "summary": "Creates Equinix Internet Access Service", "description": "By passing in the appropriate options, you can create Equinix Internet Access Service product. The entire request either succeeds or fails. In case of failure all the changes in the system are rolled back, so the system gets back to its stated before submitting the request\n\nPart of the Equinix Internet Access API family (internetaccessv2). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccessv2" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "SINGLE - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide\nDUAL - Internet Access Service supported with two redundant Connections originating from two redundant AccessPoints on the Aside and terminating to two redundant Internet Routers on the ZSide\n", "required": true, "schema": { "$ref": "#/components/schemas/Type_f2c412ba" } }, { "name": "connections", "description": "Collection of service connections uuids", "required": true, "schema": { "maxItems": 2, "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "description": "Collection of service connections uuids" } }, { "name": "routingProtocol", "required": true, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/RoutingProtocol_9ff713bf" }, { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "default": "DIRECT" }, "ipv4": { "allOf": [ { "$ref": "#/components/schemas/Ipv4_a0473817" }, { "type": "object", "properties": { "peerings": { "maxItems": 2, "minItems": 0, "type": "array", "items": { "type": "object", "properties": { "connection": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" } } }, "equinixPeerIps": { "type": "array", "items": { "pattern": "^(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/(?:[0-2]?[0-9]|3[0-2]))?$", "type": "string" }, "description": "Peering IP addresses in Version 4 (IPv4)\n" }, "equinixVRRPIp": { "pattern": "^(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/(?:[0-2]?[0-9]|3[0-2]))?$", "type": "string", "description": "Virtual router group IP addresses in Version 4 (IPv4)\n", "example": "18.15.15.18" } } } } } } ] }, "ipv6": { "allOf": [ { "$ref": "#/components/schemas/Ipv6_41dd5021" }, { "type": "object", "properties": { "peerings": { "maxItems": 2, "minItems": 0, "type": "array", "items": { "type": "object", "properties": { "connection": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "equinixPeerIps": { "type": "array", "items": { "pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))(\\/(?:[6-9]|[1-5][0-9]|6[0-4]))?$", "type": "string" }, "description": "Peering IP addresses in Version 6 (IPv6)\n" }, "equinixVRRPIp": { "pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))(\\/(?:[6-9]|[1-5][0-9]|6[0-4]))?$", "type": "string", "description": "Virtual router group IP addresses in Version 6 (IPv6)\n", "example": "1002:0db8:85a3:0000:0000:8a2e:0370:6223" } } } } } } ] } }, "description": "Direct routing protocol" } ], "required": [ "type" ] }, { "allOf": [ { "$ref": "#/components/schemas/RoutingProtocol_9ff713bf" }, { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "default": "STATIC" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_a0473817" }, "ipv6": { "$ref": "#/components/schemas/Ipv6_41dd5021" } }, "description": "Static routing protocol" } ], "required": [ "type" ] }, { "allOf": [ { "$ref": "#/components/schemas/RoutingProtocol_9ff713bf" }, { "required": [ "exportPolicy", "type" ], "type": "object", "properties": { "type": { "type": "string", "default": "BGP" }, "customerAsnRange": { "enum": [ "BITS_16", "BITS_32" ], "type": "string", "description": "Customer Autonomous System Number range", "x-enum-varnames": [ "BITS_16", "BITS_32" ] }, "customerAsn": { "maximum": 4294967295.0, "minimum": 0.0, "type": "integer", "description": "Autonomous System Number", "format": "int64", "example": 16220 }, "bgpAuthKey": { "type": "string", "description": "BGP authentication key", "example": "SecretKey" }, "exportPolicy": { "enum": [ "FULL", "DEFAULT", "FULL_DEFAULT", "PARTIAL" ], "type": "string", "description": "Denotes which routes should be advertised to the internet", "example": "FULL" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_a0473817" }, "ipv6": { "$ref": "#/components/schemas/Ipv6_41dd5021" } }, "description": "BGP routing protocol" } ], "required": [ "type" ] } ] } }, { "name": "tags", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] } }, { "name": "name", "required": false, "schema": { "maxLength": 64, "type": "string" } }, { "name": "description", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/Order_47faa772" } } ], "result": { "name": "internetaccessv2_createEquinixInternetAccessv2Result", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "change", "connections", "routingProtocol", "state", "type", "useCase", "uuid" ], "type": "object", "properties": { "name": { "maxLength": 64, "type": "string" }, "description": { "maxLength": 255, "type": "string" }, "type": { "$ref": "#/components/schemas/Type_f2c412ba" }, "connections": { "maxItems": 2, "minItems": 1, "type": "array", "items": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" } } }, "description": "Collection of service connections uuids" }, "routingProtocol": { "$ref": "#/components/schemas/RoutingProtocol_9f594f18" }, "bandwidth": { "type": "integer", "description": "Service bandwidth in Mbps", "example": 1000 }, "project": { "$ref": "#/components/schemas/Project_b02a33f1" }, "account": { "$ref": "#/components/schemas/Account_2b85a339" }, "change": { "$ref": "#/components/schemas/Change_36ac7b95" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "order": { "$ref": "#/components/schemas/Order_fb21beeb" }, "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" }, "state": { "enum": [ "PENDING", "PROVISIONING", "ACTIVE", "INACTIVE", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string" }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string" } }, "x-fastmcp-top-level-schema": "ServiceCreateResponse" } }, "x-mcp-annotations": { "title": "Creates Equinix Internet Access Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "internetaccessv2_deleteEquinixInternetAccess", "summary": "Deletes Equinix Internet Access Service", "description": "Delete Equinix Internet Access product by passing the id of the service.\nThe entire request either succeeds or fails. Beta\n\nPart of the Equinix Internet Access API family (internetaccessv2). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccessv2" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Service identifier", "required": true, "schema": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } }, { "name": "dryRun", "description": "Setting this parameter to true will perform only request validation without actually deleting the service", "required": false, "schema": { "type": "boolean", "description": "Setting this parameter to true will perform only request validation without actually deleting the service", "example": true } } ], "result": { "name": "internetaccessv2_deleteEquinixInternetAccessResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Deletes Equinix Internet Access Service", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccessv2_getEquinixInternetAccessServiceDetails", "summary": "Get Equinix Internet Access Service details", "description": "Get Equinix Internet Access Service details. Beta\n\nPart of the Equinix Internet Access API family (internetaccessv2). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccessv2" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Service identifier", "required": true, "schema": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } ], "result": { "name": "internetaccessv2_getEquinixInternetAccessServiceDetailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Internetaccessv2_getEquinixInternetAccessServiceDetailsResult" } }, "x-mcp-annotations": { "title": "Get Equinix Internet Access Service details", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccessv2_getEquinixInternetAccessServices", "summary": "Get Equinix Internet Access Services", "description": "Get Equinix Internet Access Services that match specified criteria. Beta\n\nPart of the Equinix Internet Access API family (internetaccessv2). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccessv2" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "Search result offset", "required": false, "schema": { "type": "number", "example": 20, "description": "Search result offset" } }, { "name": "limit", "description": "Search result limit", "required": false, "schema": { "type": "number", "example": 35, "description": "Search result limit" } }, { "name": "sort", "description": "Search result sorting", "required": false, "schema": { "pattern": "^([-]?[\\/][a-z]+[,]?)+$", "type": "string", "example": "/name,-/type", "description": "Search result sorting" } }, { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "type": "array", "items": { "required": [ "operator", "property", "values" ], "type": "object", "properties": { "property": { "type": "string" }, "operator": { "enum": [ "" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } } } } } } ], "result": { "name": "internetaccessv2_getEquinixInternetAccessServicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "required": [ "data", "pagination", "sort" ], "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "sort": { "$ref": "#/components/schemas/Sort_c782f755" }, "data": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] } } }, { "$ref": "#/components/schemas/Result_8d1d29b8" } ] } } }, "x-fastmcp-top-level-schema": "SearchResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get Equinix Internet Access Services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccessv2_getIbxs", "summary": "Returns IBXs where EIA is available", "description": "Get IBXs\n\nPart of the Equinix Internet Access API family (internetaccessv2). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccessv2" }, { "name": "Product Availability" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "service.connection.type", "description": "Service connection type (physical, virtual)", "required": true, "schema": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "example": "IA_C", "x-enum-varnames": [ "IA_C", "IA_VC" ], "description": "Service connection type (physical, virtual)" } }, { "name": "offset", "description": "Pagination offset", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "example": 0, "description": "Pagination offset" } }, { "name": "limit", "description": "Max number of returned results", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 50, "example": 50, "description": "Max number of returned results" } }, { "name": "connection.aside.accessPoint.type", "description": "Service connection access point type. When not provided, COLO type is used by default.", "required": false, "schema": { "enum": [ "COLO", "VD", "PORT" ], "type": "string", "description": "Service connection access point type. When not provided, COLO type is used by default." } }, { "name": "asset.type", "description": "Specifies the type of an asset the user must have in the IBX", "required": false, "schema": { "enum": [ "CABINET" ], "type": "string", "example": "CABINET", "description": "Specifies the type of an asset the user must have in the IBX" } } ], "result": { "name": "internetaccessv2_getIbxsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination_a031516d" }, "data": { "type": "array", "items": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "example": "https://api.equinix.com/internetAccess/ibxs/WA1" }, "countryCode": { "type": "string", "example": "PL" }, "countryName": { "type": "string", "example": "Poland" }, "region": { "enum": [ "APAC", "EMEA", "AMER" ], "type": "string", "example": "EMEA" }, "metroCode": { "pattern": "^[A-Z]{2,2}$", "type": "string", "example": "WA" }, "ibxCode": { "type": "string", "description": "IBX data center code", "format": "^[A-Z]{2,2}[0-9]+X?$", "example": "WA1" }, "geoCoordinates": { "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "type": "number", "example": 53.55 }, "longitude": { "type": "number", "example": 9.95 } } } }, "description": "IBX object" } } }, "x-fastmcp-top-level-schema": "IbxPage" } }, "x-mcp-annotations": { "title": "Returns IBXs where EIA is available", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "internetaccessv2_updateEquinixInternetAccess", "summary": "Updates Equinix Internet Access Service", "description": "Updates properties of Equinix Internet Access\n\nPart of the Equinix Internet Access API family (internetaccessv2). Equinix Internet Access (EIA): order and manage dedicated internet service.", "tags": [ { "name": "internetaccessv2" }, { "name": "EIA Service" }, { "name": "internet" }, { "name": "network" } ], "paramStructure": "by-name", "params": [ { "name": "serviceId", "description": "Service identifier", "required": true, "schema": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } }, { "name": "body", "description": "Only one replace operation allowed for \"/bandwidth\" path.", "required": true, "schema": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Operation type. Allowed values:\n- replace\n- add\n- remove\n", "format": "^(replace|add|remove)$" }, "path": { "type": "string", "description": "Path inside document leading to updated parameter. Allowed values:\n- /bandwidth\n- /routingProtocol/ipv4/customerRoutes[*]\n- /routingProtocol/ipv6/customerRoutes[*]\n", "format": "^(\\/bandwidth|\\/routingProtocol\\/(?:ipv4|ipv6)\\/(?:customerRoutes\\[\\*\\]|peerings\\[\\*\\]\\/(?:equinixPeerIps|equinixVRRPIp)))$", "example": "/bandwidth" }, "value": { "type": "string", "description": "New value for updated parameter.\n\nAllowed value for PA is prefixLength, e.g. \"30\"\nAllowed value for PI is prefix with subnetSize. e.g. \"192.168.1.0/24\"\n" }, "order": { "$ref": "#/components/schemas/Order_47faa772" } }, "description": "Change operation data" }, "description": "Only one replace operation allowed for \"/bandwidth\" path." } }, { "name": "dryRun", "description": "Setting this parameter to true will perform only request validation without actually updating the service", "required": false, "schema": { "type": "boolean", "description": "Setting this parameter to true will perform only request validation without actually updating the service", "example": true } } ], "result": { "name": "internetaccessv2_updateEquinixInternetAccessResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Internetaccessv2_getEquinixInternetAccessServiceDetailsResult" } }, "x-mcp-annotations": { "title": "Updates Equinix Internet Access Service", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "list_docs", "summary": "List Equinix Docs", "description": "List and filter Equinix documentation by topic, product, or keywords. Supports flexible word matching (e.g., 'Fabric providers' will find 'Fabric Provider Guide', 'Provider Management', etc.)", "tags": [ { "name": "docs" } ], "paramStructure": "by-name", "params": [ { "name": "filter_term", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "result": { "name": "list_docsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "result": { "type": "string" } }, "required": [ "result" ], "type": "object", "x-fastmcp-wrap-result": true } } }, { "name": "lookup_Get_Locations_by_permission_code", "summary": "Get Locations by permission code", "description": "This method retrieves all the user’s IBX locations, accounts, cages and cabinets information according to their ordering permission. This includes A-side and Z-side location information for a cross connect order.\n\nPart of the Equinix Lookup API family (lookup). Based on a user's permission, a user may view their locations, provider and patch panel in their organization. These locations can be filtered by permission code, account number, cage and cabinet details to get both A Side and Z side IBX locations and patch panel available ports to place an order.", "tags": [ { "name": "lookup" }, { "name": "Lookup" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "permissionCode", "description": "List of Permission code to be filtered", "required": true, "schema": { "enum": [ "CROSS_CONNECT", "WORK_VISIT", "SHIPMENTS" ], "type": "string", "description": "List of Permission code to be filtered" } }, { "name": "ibxs", "description": "List of IBXs to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of IBXs to be filtered" } }, { "name": "providerAccountNumber", "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`. This is only applicable when permissionCode is `CROSS_CONNECT`", "required": false, "schema": { "type": "string", "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`. This is only applicable when permissionCode is `CROSS_CONNECT`" } }, { "name": "aSideIbx", "description": "A-Side IBX details to fetch the (Z-side). This is only applicable when permissionCode is `CROSS_CONNECT`", "required": false, "schema": { "type": "string", "description": "A-Side IBX details to fetch the (Z-side). This is only applicable when permissionCode is `CROSS_CONNECT`" } }, { "name": "connectionService", "description": "Type of connection service to fetch the Z-side details. This is only applicable when permissionCode is `CROSS_CONNECT` and is required when searching for zSide details.", "required": false, "schema": { "type": "string", "description": "Type of connection service to fetch the Z-side details. This is only applicable when permissionCode is `CROSS_CONNECT` and is required when searching for zSide details." } }, { "name": "details", "description": "When `true`, API response returns cage, cabinet and account details", "required": false, "schema": { "type": "boolean", "default": false, "description": "When `true`, API response returns cage, cabinet and account details" } } ], "result": { "name": "lookup_Get_Locations_by_permission_codeResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "crossConnects": { "type": "array", "items": { "type": "object", "properties": { "ibx": { "type": "string", "description": "IBX locations code", "example": "AM1" }, "accessRestricted": { "type": "boolean", "description": "IBX access is restricted when the value is `true`", "default": false }, "specialPrivilege": { "type": "boolean", "description": "When set to `true`, user will be allowed to access IBXs with restricted access. This only applies for specific partners", "default": false }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Customer account number", "example": "100013200" }, "accountName": { "type": "string", "description": "Customer account name", "example": "Legal Account name" }, "allowOrder": { "type": "boolean", "description": "When set to `true`, User is allowed to place an orders on this account", "default": true } } } }, "cages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Cage Unique space id", "example": "AM1:00000:0000" }, "type": { "enum": [ "SHARED", "PRIVATE" ], "type": "string", "description": "Type of the cage", "default": "PRIVATE" }, "accountNumbers": { "type": "string", "description": "Customer account number associated with cage", "example": "100013200" }, "cabinetId": { "type": "string", "description": "Cabinet Unique space id", "example": "AM2:0G:012320:0000" }, "cabinetType": { "enum": [ "PRIVATE", "DEMARCATION" ], "type": "string", "description": "Type of the cabinet", "example": "PRIVATE" } } } } } } } }, "x-fastmcp-top-level-schema": "locations_details_response" } }, "x-mcp-annotations": { "title": "Get Locations by permission code", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "lookup_Retrieve_all_patch_panels", "summary": "Retrieve all patch panels", "description": "This method retrieves all available patch panels associated with a cabinet for a user with cross connects ordering permission.\n\nPart of the Equinix Lookup API family (lookup). Based on a user's permission, a user may view their locations, provider and patch panel in their organization. These locations can be filtered by permission code, account number, cage and cabinet details to get both A Side and Z side IBX locations and patch panel available ports to place an order.", "tags": [ { "name": "lookup" }, { "name": "Lookup" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "cabinetId", "description": "ID of the cabinet", "required": true, "schema": { "type": "string", "description": "ID of the cabinet" } }, { "name": "providerAccountNumber", "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`", "required": false, "schema": { "type": "string", "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`" } }, { "name": "aSideIbx", "description": "The IBX location code for A-Side. When used together with `providerAccountNumber`, this returns Z-side patch panel details.", "required": false, "schema": { "type": "string", "description": "The IBX location code for A-Side. When used together with `providerAccountNumber`, this returns Z-side patch panel details." } }, { "name": "accountNumber", "description": "Account number is only required when cabinet is shared.", "required": false, "schema": { "type": "string", "description": "Account number is only required when cabinet is shared." } } ], "result": { "name": "lookup_Retrieve_all_patch_panelsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "title": "Get all the patch panel response data", "required": [ "data" ], "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "patchPanelId": { "type": "string", "description": "Patch panel unique ID / serial number", "example": "PP:000:01231231" }, "availablePortCount": { "type": "number", "description": "Available ports for use", "example": 48 }, "patchPanelReferenceId": { "type": "string", "description": "Unique reference ID associated with patch panel" }, "ifcEnabled": { "type": "boolean", "description": "Patch panel will support only intra facility when `true`", "default": false, "example": false }, "provisioningType": { "$ref": "#/components/schemas/ProvisioningType" } } }, "x-fastmcp-top-level-schema": "patchpanel_Response" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve all patch panels", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "lookup_Retrieve_list_of_connection_services", "summary": "Retrieve list of connection services", "description": "This method retrieves a list of supported connection services such as media types, protocol types, connector types and circuit counts.\n\nPart of the Equinix Lookup API family (lookup). Based on a user's permission, a user may view their locations, provider and patch panel in their organization. These locations can be filtered by permission code, account number, cage and cabinet details to get both A Side and Z side IBX locations and patch panel available ports to place an order.", "tags": [ { "name": "lookup" }, { "name": "Lookup" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "ibx", "description": "IBX", "required": true, "schema": { "type": "string", "description": "IBX" } } ], "result": { "name": "lookup_Retrieve_list_of_connection_servicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ResultItem" }, "x-fastmcp-top-level-schema": "Connection_services_details" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve list of connection services", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "lookup_Retrieve_list_of_providers", "summary": "Retrieve list of providers", "description": "This method retrieves all available cross connect service providers to a user with cross connects ordering permission.\n\nPart of the Equinix Lookup API family (lookup). Based on a user's permission, a user may view their locations, provider and patch panel in their organization. These locations can be filtered by permission code, account number, cage and cabinet details to get both A Side and Z side IBX locations and patch panel available ports to place an order.", "tags": [ { "name": "lookup" }, { "name": "Lookup" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "cageId", "description": "Cage ID", "required": true, "schema": { "type": "string", "description": "Cage ID" } }, { "name": "accountNumber", "description": "Account number of A-Side cage", "required": true, "schema": { "type": "string", "description": "Account number of A-Side cage" } } ], "result": { "name": "lookup_Retrieve_list_of_providersResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "providerAccountName": { "type": "string", "description": "Cage account name of service provider", "example": "Account NAME" }, "providerAccountNumber": { "type": "string", "description": "Cage account number of service provider", "example": "1000001" } } }, "x-fastmcp-top-level-schema": "provider_details" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve list of providers", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "lookup_Retrieve_patch_panel_details", "summary": "Retrieve patch panel details", "description": "This method retrieves details of a patch panel by its ID to a user with cross connects ordering permission.\n\nPart of the Equinix Lookup API family (lookup). Based on a user's permission, a user may view their locations, provider and patch panel in their organization. These locations can be filtered by permission code, account number, cage and cabinet details to get both A Side and Z side IBX locations and patch panel available ports to place an order.", "tags": [ { "name": "lookup" }, { "name": "Lookup" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "patchPanelId", "description": "ID of patch panel", "required": true, "schema": { "type": "string", "description": "ID of patch panel" } }, { "name": "providerAccountNumber", "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`", "required": false, "schema": { "type": "string", "description": "The service provider's account number (Z-side) linked to their cage. Mandatory when used together with `aSideIbx`" } }, { "name": "aSideIbx", "description": "The IBX location code for A-Side. When used together with `providerAccountNumber` and `accountNumber`, this returns Z-side patch panel details.", "required": false, "schema": { "type": "string", "description": "The IBX location code for A-Side. When used together with `providerAccountNumber` and `accountNumber`, this returns Z-side patch panel details." } }, { "name": "accountNumber", "description": "A-Side cage account number", "required": false, "schema": { "type": "string", "description": "A-Side cage account number" } } ], "result": { "name": "lookup_Retrieve_patch_panel_detailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "patchPanelId": { "type": "string", "description": "Patch panel ID / serial number", "example": "PP:0000:0010312312" }, "ibx": { "type": "string", "description": "IBX location code", "example": "AM1" }, "cageId": { "type": "string", "description": "Cage ID", "example": "AM1:00:000000" }, "cabinetId": { "type": "string", "description": "Cabinet ID", "example": "AM1:00:000000:0000" }, "accountNumber": { "type": "string", "description": "Customer cage account number" }, "accountName": { "type": "string", "description": "Customer cage account name" }, "dedicatedMediaType": { "type": "string", "description": "Type of dedicated media" }, "preWired": { "type": "boolean", "description": "Prewired status of cross connects. When `true`, cross connects are prewired" }, "type": { "enum": [ "CUSTOMER_PROVIDED", "EQUINIX_PROVIDED" ], "type": "string", "description": "Patch panel type", "example": "CUSTOMER_PROVIDED" }, "ifcEnabled": { "type": "boolean", "description": "Identifies if intra-facility cable (IFC) connection is required for patch panel. When `true`, IFC connection is required.", "example": false }, "rackLocations": { "type": "string", "description": "Rack location of patch panel", "example": "Front" }, "installLocations": { "enum": [ "STANDARD" ], "type": "string", "description": "Location of installed patch panel", "example": "Standard" }, "installationRequired": { "type": "boolean", "description": "If `true`, Equinix will install cross connect from demarcation panel to customer equipment. ", "default": false }, "circuitAvailable": { "type": "boolean", "description": "if `true`, circuits are available for patch panel", "default": false }, "availablePorts": { "type": "array", "items": { "type": "number", "example": 1 }, "description": "Individually identified ports that are available out of the total number of ports." }, "connectionServices": { "type": "array", "items": { "$ref": "#/components/schemas/ResultItem" } }, "usedPortsDetails": { "type": "array", "items": { "type": "object", "properties": { "portNumber": { "type": "number", "description": "Port number that is currently in use", "example": 7 }, "serialNumber": { "type": "string", "description": "Serial number or cable id", "example": 99910002 }, "connectionServicesName": { "enum": [ "COAX", "MP4_CABLE", "MULTI_MODE_FIBER", "POTS", "SINGLE_MODE_FIBER", "UTP" ], "type": "string", "description": "The name of the available connection service.", "example": "SINGLE_MODE_FIBER" }, "zSideProviderName": { "type": "string", "description": "Name of Z-Side service provider", "example": "ABC Telecom" }, "circuitId": { "type": "string", "example": "/L8YX/999999//ATI/" } } } }, "provisioningType": { "$ref": "#/components/schemas/ProvisioningType" } }, "x-fastmcp-top-level-schema": "patch_panel_details" } }, "x-mcp-annotations": { "title": "Retrieve patch panel details", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_checkRestoreAnalysisOfBackupByUuid", "summary": "Checks Feasibility of Restore", "description": "Checks the feasibility of restoring the backup of a virtual device. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique ID of a device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique ID of a device" } }, { "name": "backupUuid", "description": "Unique ID of a backup", "required": false, "schema": { "type": "string", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b", "description": "Unique ID of a backup" } } ], "result": { "name": "network-edge_checkRestoreAnalysisOfBackupByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "deviceBackup": { "type": "object", "properties": { "deviceBackup": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique ID of the backup.", "example": "ac8a8497-1b6e-42d1-9075-acf23a62ed50" }, "name": { "type": "string", "description": "The name of the backup.", "example": "My New Backup" }, "status": { "enum": [ "COMPLETED", "FAILED", "IN_PROGRESS" ], "type": "string", "description": "The status of the backup.", "example": "COMPLETED" }, "deleteAllowed": { "type": "boolean", "description": "Whether you can delete the backup. Only backups in the COMPELTED or FAILED states can be deleted.", "example": true } }, "description": "Details of a device backup for restore" } }, "description": "An object that has the device backup details." }, "services": { "type": "object", "properties": { "serviceName": { "type": "object", "properties": { "serviceId": { "type": "string", "description": "The unique ID of the service.", "example": "ac8a8497-1b6e-42d1-9075-acf23a62ed50" }, "serviceName": { "type": "string", "description": "The name of the service.", "example": "L2 Connection with AWS" }, "operationNeededToPerform": { "type": "string", "description": "The operation you must perform to restore the backup successfully. UNSUPPORTED- You cannot restore this backup. DELETE- You need to delete this service to restore the backup. NONE- You do not need to change anything to restore the backup.", "example": "DELETE" } }, "description": "Information about a service associated with a backup" } }, "description": "An object that has the analysis of services associated with the backup or services added to the device since the backup." }, "restoreAllowedAfterDeleteOrEdit": { "type": "boolean", "description": "If True, the backup is restorable once you perform the recommended opertions. If False, the backup is not restorable.", "example": false } }, "x-fastmcp-top-level-schema": "RestoreBackupInfoVerbose" } }, "x-mcp-annotations": { "title": "Checks Feasibility of Restore", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_createAgreement", "summary": "Create an agreement", "description": "Call this API to post an agreement. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Account number.", "required": false, "schema": { "type": "string", "description": "Account number.", "example": "456446" } }, { "name": "apttusId", "description": "The version number of the agreement.", "required": false, "schema": { "type": "string", "description": "The version number of the agreement.", "example": "c2Z34000002CXRm" } } ], "result": { "name": "network-edge_createAgreementResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "status": { "enum": [ "SUCCESS", "FAILED" ], "type": "string", "description": "Status of the request.", "example": "SUCCESS" } }, "description": "Response for agreement acceptance", "x-fastmcp-top-level-schema": "AgreementAcceptResponse" } }, "x-mcp-annotations": { "title": "Create an agreement", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createDeviceACLTemplate", "summary": "Create ACL Template", "description": "Creates ACL templates. You can find the unique ID of the ACL template in the location header.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "name", "description": "The ACL template name.", "required": true, "schema": { "type": "string", "description": "The ACL template name.", "example": "Test Template" } }, { "name": "description", "description": "The ACL template description.", "required": true, "schema": { "type": "string", "description": "The ACL template description.", "example": "Test Template Description" } }, { "name": "inboundRules", "description": "An array of inbound rules.", "required": true, "schema": { "$ref": "#/components/schemas/InboundRules_2b9969ef" } }, { "name": "accountUcmId", "description": "A reseller creating an ACL template for a customer can pass the accountUcmId of the customer.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "A reseller creating an ACL template for a customer can pass the accountUcmId of the customer." } }, { "name": "projectId", "description": "Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.", "required": false, "schema": { "$ref": "#/components/schemas/ProjectId_cef15e62" } } ], "result": { "name": "network-edge_createDeviceACLTemplateResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique ID of the created virtual device", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" } }, "description": "Response for virtual device creation", "x-fastmcp-top-level-schema": "VirtualDeviceCreateResponse" } }, "x-mcp-annotations": { "title": "Create ACL Template", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createDeviceBackup", "summary": "Creates Device Backup", "description": "Creates the backup of a virtual device. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "deviceUuid", "description": "The unique Id of a virtual device.", "required": true, "schema": { "type": "string", "description": "The unique Id of a virtual device.", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8" } }, { "name": "name", "description": "The name of backup.", "required": true, "schema": { "type": "string", "description": "The name of backup.", "example": "My New Backup" } } ], "result": { "name": "network-edge_createDeviceBackupResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The ID of the newly created SSH user.", "example": "12828472-e6e9-4f2b-98f7-b79cf0fab4ff" } }, "description": "Response for SSH user creation", "x-fastmcp-top-level-schema": "SshUserCreateResponse" } }, "x-mcp-annotations": { "title": "Creates Device Backup", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createDeviceLinkGroup", "summary": "Create Device Link", "description": "Call this API to create a device link between virtual devices. You can include any devices that are registered and provisioned.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Link-Groups-and-Connections" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "groupName", "description": "Group name.", "required": true, "schema": { "type": "string", "description": "Group name.", "example": "linkGroup" } }, { "name": "subnet", "description": "Subnet of the link group.", "required": true, "schema": { "type": "string", "description": "Subnet of the link group.", "example": "192.164.0.0/29" } }, { "name": "redundancyType", "description": "Whether the connection should be created through Fabric's primary or secondary port.", "required": false, "schema": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Whether the connection should be created through Fabric's primary or secondary port.", "example": "SECONDARY" } }, { "name": "linkDevices", "description": "An array of devices to link.", "required": false, "schema": { "$ref": "#/components/schemas/LinkDevices_21e67921" } }, { "name": "metroLinks", "description": "An array of links.", "required": false, "schema": { "$ref": "#/components/schemas/MetroLinks_7fdb4dcb" } } ], "result": { "name": "network-edge_createDeviceLinkGroupResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique ID of the device link group", "example": "a5d9182d-c529-451d-b137-3742d5a742ce" } }, "description": "Response containing device link group UUID", "x-fastmcp-top-level-schema": "DeviceLinkGroupResponse" } }, "x-mcp-annotations": { "title": "Create Device Link", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createDeviceRMAByUuid", "summary": "Trigger Device RMA", "description": "Triggers a request to create an RMA of a device. The payload to create an RMA is different for different vendors. You will need to enter a license to create an RMA.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-RMA" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUuid", "description": "Unique ID of a device", "required": true, "schema": { "type": "string", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae", "description": "Unique ID of a device" } }, { "name": "version", "description": "Any version you want.", "required": true, "schema": { "type": "string", "description": "Any version you want.", "example": "17.09.01a" } }, { "name": "cloudInitFileId", "description": "For a C8KV device, this is the Id of the uploaded bootstrap file. Upload your Cisco bootstrap file by calling Upload File. In the response, you'll get a fileUuid that you can enter here as cloudInitFileId. This field may be required for some vendors.", "required": false, "schema": { "type": "string", "description": "For a C8KV device, this is the Id of the uploaded bootstrap file. Upload your Cisco bootstrap file by calling Upload File. In the response, you'll get a fileUuid that you can enter here as cloudInitFileId. This field may be required for some vendors.", "example": "029a0bcd-0b2f-4bc5-b875-b506aa4b9738" } }, { "name": "licenseFileId", "description": "This is the Id of the uploaded license file. For a CSR1KV SDWAN device, upload your license file by calling Upload License File. In the response, you'll get a fileId that you can enter here as licenseFileId. This field may be required for some vendors.", "required": false, "schema": { "type": "string", "description": "This is the Id of the uploaded license file. For a CSR1KV SDWAN device, upload your license file by calling Upload License File. In the response, you'll get a fileId that you can enter here as licenseFileId. This field may be required for some vendors.", "example": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730" } }, { "name": "token", "description": "License token. For a cluster, you will need to provide license tokens for both node0 and node1. To get the exact payload for different vendors, check the Postman script on the API Reference page of online documentation.", "required": false, "schema": { "type": "string", "description": "License token. For a cluster, you will need to provide license tokens for both node0 and node1. To get the exact payload for different vendors, check the Postman script on the API Reference page of online documentation.", "example": "897gjikk888" } }, { "name": "vendorConfig", "description": "RMA vendor configuration", "required": false, "schema": { "type": "object", "properties": { "siteId": { "type": "string", "description": "Physical location within the Viptela overlay network, such as a branch office, or a campus (relevant only for Cisco SD-WANs)", "example": "567" }, "systemIpAddress": { "type": "string", "description": "IP assigned to the router and vSmart controller (relevant only for Cisco SD-WANs)", "example": "192.164.0.0" }, "licenseKey": { "type": "string", "description": "License key. Mandatory for some devices.", "example": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7" }, "licenseSecret": { "type": "string", "description": "License secret (Secret key). Mandatory for some devices.", "example": "h5j0i45e83324pblbfca764532c4a640e7801f0" }, "controller1": { "type": "string", "description": "For Fortinet devices, this is the System IP address.", "example": "54.219.248.29" }, "adminPassword": { "$ref": "#/components/schemas/AdminPassword" }, "activationKey": { "type": "string", "description": "Available on VMware Orchestration Portal", "example": "GJUK-JM2X-59BJ-2TDJ" }, "provisioningKey": { "type": "string", "description": "Mandatory for Zscaler devices", "example": "provisioningKeysample" }, "panoramaIpAddress": { "type": "string", "description": "IP address of the Panorama controller. Provide this value to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access", "example": "1.1.1.1" }, "panoramaAuthKey": { "type": "string", "description": "This key supports secure onboarding of the Palo Alto firewall devices. Provide this value to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access.", "example": "123456" } }, "description": "RMA vendor configuration" } }, { "name": "userPublicKey", "description": "An object with public key details.", "required": false, "schema": { "$ref": "#/components/schemas/UserPublicKey_6fc2aa31" } } ], "result": { "name": "network-edge_createDeviceRMAByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Trigger Device RMA", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createDeviceReloadByUuid", "summary": "Trigger Virtual Device Soft Reboot", "description": "Triggers the soft reboot of a device. Please send the unique Id of the device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUUID", "description": "Unique ID of a virtual device.", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique ID of a virtual device." } } ], "result": { "name": "network-edge_createDeviceReloadByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Trigger Virtual Device Soft Reboot", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createDeviceTemplatesbyUuid", "summary": "Add ACL to Virtual Device", "description": "Updates the details of ACL templates associated with a device. You must provide the unique ID of an existing virtual device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUuid", "description": "Unique Id of a virtual device.", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a virtual device." } }, { "name": "aclDetails", "description": "An array of ACLs.", "required": true, "schema": { "$ref": "#/components/schemas/AclDetails_f1a415d4" } }, { "name": "accountUcmId", "description": "A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer." } } ], "result": { "name": "network-edge_createDeviceTemplatesbyUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Add ACL to Virtual Device", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createVirtualDevice", "summary": "Create Virtual Device", "description": "Creates a virtual device. Sub-customers cannot choose the subscription licensing option. To create a device, you must accept the Order Terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "version", "description": "Version.", "required": true, "schema": { "type": "string", "description": "Version.", "example": "16.09.03" } }, { "name": "deviceTypeCode", "description": "Device type code (e.g., C8000V)", "required": true, "schema": { "$ref": "#/components/schemas/DeviceTypeCode" } }, { "name": "agreeOrderTerms", "description": "To create a device, you must accept the order terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms.", "required": true, "schema": { "type": "boolean", "description": "To create a device, you must accept the order terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms.", "example": true } }, { "name": "licenseMode", "description": "License type. One of SUB (Subscription) or BYOL (Bring Your Own License)", "required": true, "schema": { "enum": [ "SUB", "BYOL" ], "type": "string", "description": "License type. One of SUB (Subscription) or BYOL (Bring Your Own License)", "example": "SUB" } }, { "name": "metroCode", "description": "Metro code", "required": true, "schema": { "type": "string", "description": "Metro code", "example": "SV" } }, { "name": "virtualDeviceName", "description": "Virtual device name for identification. This should be minimum 3 and maximum 50 characters long.", "required": true, "schema": { "type": "string", "description": "Virtual device name for identification. This should be minimum 3 and maximum 50 characters long.", "example": "Router1-c8000v" } }, { "name": "notifications", "description": "Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses.", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses.", "example": [ "test1@equinix.com", "test2@equinix.com" ] } }, { "name": "deviceManagementType", "description": "Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED", "required": true, "schema": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "description": "Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED", "example": "EQUINIX-CONFIGURED" } }, { "name": "core", "description": "The desired number of cores.", "required": true, "schema": { "type": "integer", "description": "The desired number of cores.", "format": "int32", "example": 4 } }, { "name": "draft", "description": "Whether to save this as a draft.", "required": false, "schema": { "type": "boolean", "default": false, "example": false, "description": "Whether to save this as a draft." } }, { "name": "draftUuid", "description": "The unique ID of the draft to be promoted to a device.", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "The unique ID of the draft to be promoted to a device." } }, { "name": "accountNumber", "description": "Account number. Either an account number or accountReferenceId is required.", "required": false, "schema": { "type": "string", "description": "Account number. Either an account number or accountReferenceId is required.", "example": "10478397" } }, { "name": "accountReferenceId", "description": "AccountReferenceId. This is a temporary ID that can be used to create a device when the account status is still pending, not active. Either an account number or accountReferenceId is required.", "required": false, "schema": { "type": "string", "description": "AccountReferenceId. This is a temporary ID that can be used to create a device when the account status is still pending, not active. Either an account number or accountReferenceId is required.", "example": "209809" } }, { "name": "projectId", "description": "Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.", "required": false, "schema": { "type": "string", "description": "Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.", "example": "XXXX-XXXX-XXXXX-XXXXXXXXXXXXXXXX" } }, { "name": "hostNamePrefix", "description": "Host name prefix for identification. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14 characters; Aruba 2-24 characters.", "required": false, "schema": { "$ref": "#/components/schemas/HostNamePrefix" } }, { "name": "licenseCategory", "description": "This field will be deprecated in the future.", "required": false, "schema": { "type": "string", "description": "This field will be deprecated in the future.", "example": "flex" } }, { "name": "licenseFileId", "description": "For Juniper devices you need to provide a licenseFileId if you want to BYOL (Bring Your Own License). You get a licenseFileId when you upload a license file by calling license upload API (Upload a license file before creating a virtual device). For Cisco devices, you do not need to provide a licenseFileId at the time of device creation. Once the device is provisioned, you can get the deviceSerialNo by calling Get virtual device {uuid} API. With the deviceSerialNo you can generate a license file on Cisco site. Afterward, you can upload the license file by calling license upload API (Upload a license file after creating a virtual device).", "required": false, "schema": { "$ref": "#/components/schemas/LicenseFileId" } }, { "name": "licenseToken", "description": "In case you want to BYOL (Bring Your Own License) for a Palo Alto device, you must provide a license token. This field must have 8 alphanumeric characters.", "required": false, "schema": { "type": "string", "description": "In case you want to BYOL (Bring Your Own License) for a Palo Alto device, you must provide a license token. This field must have 8 alphanumeric characters.", "example": "V74191621" } }, { "name": "day0TextFileId", "description": "Some devices require a day0TextFileId. Upload your license file by calling Upload File API. You'll get a fileUuid in the response. You can enter the value in the day0TextFileId field of the create payload to create a virtual device. Check the payloads of individual devices (provided as Postman Scripts on our API doc site) for details.", "required": false, "schema": { "$ref": "#/components/schemas/Day0TextFileId" } }, { "name": "termlength", "description": "Term length in months.", "required": false, "schema": { "type": "string", "description": "Term length in months.", "example": "12" } }, { "name": "packageCode", "description": "Software package code", "required": false, "schema": { "type": "string", "description": "Software package code", "example": "IPBASE" } }, { "name": "sshUsers", "description": "An array of sshUsernames and passwords", "required": false, "schema": { "$ref": "#/components/schemas/SshUsers_922add19" } }, { "name": "throughput", "description": "Numeric throughput. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options.", "required": false, "schema": { "type": "integer", "description": "Numeric throughput. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options.", "format": "int32", "example": 1 } }, { "name": "throughputUnit", "description": "Throughput unit.", "required": false, "schema": { "type": "string", "description": "Throughput unit.", "example": "Gbps" } }, { "name": "tier", "description": "Tier throughput. Relevant for Cisco8KV devices. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. Possible values - 0, 1, 2, 3. Default - 2", "required": false, "schema": { "type": "integer", "description": "Tier throughput. Relevant for Cisco8KV devices. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. Possible values - 0, 1, 2, 3. Default - 2", "example": 1 } }, { "name": "orderingContact", "description": "Username of the ordering contact.", "required": false, "schema": { "type": "string", "description": "Username of the ordering contact.", "example": "subuser01" } }, { "name": "aclDetails", "description": "An array of ACLs", "required": false, "schema": { "$ref": "#/components/schemas/AclDetails_90ec39be" } }, { "name": "additionalBandwidth", "description": "Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps.", "required": false, "schema": { "type": "integer", "description": "Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps.", "format": "int32", "example": 100 } }, { "name": "interfaceCount", "description": "The desired number of interfaces.", "required": false, "schema": { "type": "integer", "description": "The desired number of interfaces.", "format": "int32", "example": 10 } }, { "name": "siteId", "description": "Site ID.", "required": false, "schema": { "type": "string", "description": "Site ID.", "example": "12345" } }, { "name": "systemIpAddress", "description": "System IP address.", "required": false, "schema": { "type": "string", "description": "System IP address.", "example": "192.168.2.5" } }, { "name": "vendorConfig", "description": "Vendor-specific configuration", "required": false, "schema": { "$ref": "#/components/schemas/VendorConfig_9949fa91" } }, { "name": "userPublicKey", "description": "An object with public key details.", "required": false, "schema": { "$ref": "#/components/schemas/UserPublicKey_6fc2aa31" } }, { "name": "ipType", "description": "This field is deprecated. The ipType value always defaults to STATIC.", "required": false, "schema": { "enum": [ "STATIC" ], "type": "string", "description": "This field is deprecated. The ipType value always defaults to STATIC.", "example": "STATIC" } }, { "name": "sshInterfaceId", "description": "You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices.", "required": false, "schema": { "type": "string", "description": "You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices.", "example": "4" } }, { "name": "smartLicenseUrl", "description": "License URL. This field is only relevant for Ciso ASAv devices.", "required": false, "schema": { "type": "string", "description": "License URL. This field is only relevant for Ciso ASAv devices.", "example": "https://wwww.equinix.com" } }, { "name": "diverseFromDeviceUuid", "description": "Unique ID of an existing device. Use this field to let Equinix know if you want your new device to be in a different location from any existing virtual device. This field is only meaningful for single devices.", "required": false, "schema": { "type": "string", "description": "Unique ID of an existing device. Use this field to let Equinix know if you want your new device to be in a different location from any existing virtual device. This field is only meaningful for single devices.", "example": "ac8a8497-1b6e-42d1-9075-acf23a62ed50" } }, { "name": "clusterDetails", "description": "Cluster configuration details", "required": false, "schema": { "$ref": "#/components/schemas/ClusterDetails" } }, { "name": "primaryDeviceUuid", "description": "This field is mandatory if you are using this API to add a secondary device to an existing primary device.", "required": false, "schema": { "type": "string", "description": "This field is mandatory if you are using this API to add a secondary device to an existing primary device.", "example": "ac8a8497-1b6e-42d1-9075-acf23a62ed50" } }, { "name": "connectivity", "description": "Specifies the connectivity on the device. You can have INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. Private devices don't have ACLs or bandwidth.", "required": false, "schema": { "enum": [ "INTERNET-ACCESS", "PRIVATE", "INTERNET-ACCESS-WITH-PRVT-MGMT" ], "type": "string", "description": "Specifies the connectivity on the device. You can have INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. Private devices don't have ACLs or bandwidth.", "example": "INTERNET-ACCESS" } }, { "name": "channelPartner", "description": "The name of the channel partner.", "required": false, "schema": { "type": "string", "description": "The name of the channel partner.", "example": "SDCI" } }, { "name": "cloudInitFileId", "description": "The Id of a previously uploaded license or cloud_init file.", "required": false, "schema": { "type": "string", "description": "The Id of a previously uploaded license or cloud_init file.", "example": "2d732d49-7a00-4839-aeca-8a2ff89da691" } }, { "name": "purchaseOrderNumber", "description": "Purchase Order information will be included in your order confirmation email.", "required": false, "schema": { "type": "string", "description": "Purchase Order information will be included in your order confirmation email.", "example": "789065" } }, { "name": "orderReference", "description": "Enter a short name/number to identify this order on the invoice.", "required": false, "schema": { "type": "string", "description": "Enter a short name/number to identify this order on the invoice.", "example": "345678A" } }, { "name": "secondary", "description": "Request to create a secondary HA device", "required": false, "schema": { "$ref": "#/components/schemas/Secondary_20f9e0a2" } } ], "result": { "name": "network-edge_createVirtualDeviceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique ID of the created virtual device", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" } }, "description": "Response for virtual device creation", "x-fastmcp-top-level-schema": "VirtualDeviceCreateResponse" } }, "x-mcp-annotations": { "title": "Create Virtual Device", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_createVirtualDeviceByUuid", "summary": "Update Device Draft", "description": "This API is for updating a virtual device draft
and does not support device update as of now.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "draft", "description": "draft", "required": true, "schema": { "type": "boolean", "example": true, "description": "draft" } }, { "name": "uuid", "description": "Unique Id of a Virtual Device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a Virtual Device" } }, { "name": "version", "description": "Version.", "required": true, "schema": { "type": "string", "description": "Version.", "example": "16.09.03" } }, { "name": "deviceTypeCode", "description": "Device type code (e.g., C8000V)", "required": true, "schema": { "$ref": "#/components/schemas/DeviceTypeCode" } }, { "name": "agreeOrderTerms", "description": "To create a device, you must accept the order terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms.", "required": true, "schema": { "type": "boolean", "description": "To create a device, you must accept the order terms. Call Get Order Terms to review the details. If you are creating an Equinix-Configured device, read your vendor's terms by calling Get Vendor Terms.", "example": true } }, { "name": "licenseMode", "description": "License type. One of SUB (Subscription) or BYOL (Bring Your Own License)", "required": true, "schema": { "enum": [ "SUB", "BYOL" ], "type": "string", "description": "License type. One of SUB (Subscription) or BYOL (Bring Your Own License)", "example": "SUB" } }, { "name": "metroCode", "description": "Metro code", "required": true, "schema": { "type": "string", "description": "Metro code", "example": "SV" } }, { "name": "virtualDeviceName", "description": "Virtual device name for identification. This should be minimum 3 and maximum 50 characters long.", "required": true, "schema": { "type": "string", "description": "Virtual device name for identification. This should be minimum 3 and maximum 50 characters long.", "example": "Router1-c8000v" } }, { "name": "notifications", "description": "Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses.", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "Email addresses for notification. We need a minimum of 1 and no more than 5 email addresses.", "example": [ "test1@equinix.com", "test2@equinix.com" ] } }, { "name": "deviceManagementType", "description": "Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED", "required": true, "schema": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "description": "Whether the device is SELF-CONFIGURED or EQUINIX-CONFIGURED", "example": "EQUINIX-CONFIGURED" } }, { "name": "core", "description": "The desired number of cores.", "required": true, "schema": { "type": "integer", "description": "The desired number of cores.", "format": "int32", "example": 4 } }, { "name": "accountNumber", "description": "Account number. Either an account number or accountReferenceId is required.", "required": false, "schema": { "type": "string", "description": "Account number. Either an account number or accountReferenceId is required.", "example": "10478397" } }, { "name": "accountReferenceId", "description": "AccountReferenceId. This is a temporary ID that can be used to create a device when the account status is still pending, not active. Either an account number or accountReferenceId is required.", "required": false, "schema": { "type": "string", "description": "AccountReferenceId. This is a temporary ID that can be used to create a device when the account status is still pending, not active. Either an account number or accountReferenceId is required.", "example": "209809" } }, { "name": "projectId", "description": "Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.", "required": false, "schema": { "type": "string", "description": "Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.", "example": "XXXX-XXXX-XXXXX-XXXXXXXXXXXXXXXX" } }, { "name": "hostNamePrefix", "description": "Host name prefix for identification. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14 characters; Aruba 2-24 characters.", "required": false, "schema": { "$ref": "#/components/schemas/HostNamePrefix" } }, { "name": "licenseCategory", "description": "This field will be deprecated in the future.", "required": false, "schema": { "type": "string", "description": "This field will be deprecated in the future.", "example": "flex" } }, { "name": "licenseFileId", "description": "For Juniper devices you need to provide a licenseFileId if you want to BYOL (Bring Your Own License). You get a licenseFileId when you upload a license file by calling license upload API (Upload a license file before creating a virtual device). For Cisco devices, you do not need to provide a licenseFileId at the time of device creation. Once the device is provisioned, you can get the deviceSerialNo by calling Get virtual device {uuid} API. With the deviceSerialNo you can generate a license file on Cisco site. Afterward, you can upload the license file by calling license upload API (Upload a license file after creating a virtual device).", "required": false, "schema": { "$ref": "#/components/schemas/LicenseFileId" } }, { "name": "licenseToken", "description": "In case you want to BYOL (Bring Your Own License) for a Palo Alto device, you must provide a license token. This field must have 8 alphanumeric characters.", "required": false, "schema": { "type": "string", "description": "In case you want to BYOL (Bring Your Own License) for a Palo Alto device, you must provide a license token. This field must have 8 alphanumeric characters.", "example": "V74191621" } }, { "name": "day0TextFileId", "description": "Some devices require a day0TextFileId. Upload your license file by calling Upload File API. You'll get a fileUuid in the response. You can enter the value in the day0TextFileId field of the create payload to create a virtual device. Check the payloads of individual devices (provided as Postman Scripts on our API doc site) for details.", "required": false, "schema": { "$ref": "#/components/schemas/Day0TextFileId" } }, { "name": "termlength", "description": "Term length in months.", "required": false, "schema": { "type": "string", "description": "Term length in months.", "example": "12" } }, { "name": "packageCode", "description": "Software package code", "required": false, "schema": { "type": "string", "description": "Software package code", "example": "IPBASE" } }, { "name": "sshUsers", "description": "An array of sshUsernames and passwords", "required": false, "schema": { "$ref": "#/components/schemas/SshUsers_922add19" } }, { "name": "throughput", "description": "Numeric throughput. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options.", "required": false, "schema": { "type": "integer", "description": "Numeric throughput. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options.", "format": "int32", "example": 1 } }, { "name": "throughputUnit", "description": "Throughput unit.", "required": false, "schema": { "type": "string", "description": "Throughput unit.", "example": "Gbps" } }, { "name": "tier", "description": "Tier throughput. Relevant for Cisco8KV devices. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. Possible values - 0, 1, 2, 3. Default - 2", "required": false, "schema": { "type": "integer", "description": "Tier throughput. Relevant for Cisco8KV devices. For Cisco8KV self-configured devices, you can choose either numeric or tier throughput options. Possible values - 0, 1, 2, 3. Default - 2", "example": 1 } }, { "name": "orderingContact", "description": "Username of the ordering contact.", "required": false, "schema": { "type": "string", "description": "Username of the ordering contact.", "example": "subuser01" } }, { "name": "aclDetails", "description": "An array of ACLs", "required": false, "schema": { "$ref": "#/components/schemas/AclDetails_90ec39be" } }, { "name": "additionalBandwidth", "description": "Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps.", "required": false, "schema": { "type": "integer", "description": "Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps.", "format": "int32", "example": 100 } }, { "name": "interfaceCount", "description": "The desired number of interfaces.", "required": false, "schema": { "type": "integer", "description": "The desired number of interfaces.", "format": "int32", "example": 10 } }, { "name": "siteId", "description": "Site ID.", "required": false, "schema": { "type": "string", "description": "Site ID.", "example": "12345" } }, { "name": "systemIpAddress", "description": "System IP address.", "required": false, "schema": { "type": "string", "description": "System IP address.", "example": "192.168.2.5" } }, { "name": "vendorConfig", "description": "Vendor-specific configuration", "required": false, "schema": { "$ref": "#/components/schemas/VendorConfig_9949fa91" } }, { "name": "userPublicKey", "description": "An object with public key details.", "required": false, "schema": { "$ref": "#/components/schemas/UserPublicKey_6fc2aa31" } }, { "name": "ipType", "description": "This field is deprecated. The ipType value always defaults to STATIC.", "required": false, "schema": { "enum": [ "STATIC" ], "type": "string", "description": "This field is deprecated. The ipType value always defaults to STATIC.", "example": "STATIC" } }, { "name": "sshInterfaceId", "description": "You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices.", "required": false, "schema": { "type": "string", "description": "You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices.", "example": "4" } }, { "name": "smartLicenseUrl", "description": "License URL. This field is only relevant for Ciso ASAv devices.", "required": false, "schema": { "type": "string", "description": "License URL. This field is only relevant for Ciso ASAv devices.", "example": "https://wwww.equinix.com" } }, { "name": "diverseFromDeviceUuid", "description": "Unique ID of an existing device. Use this field to let Equinix know if you want your new device to be in a different location from any existing virtual device. This field is only meaningful for single devices.", "required": false, "schema": { "type": "string", "description": "Unique ID of an existing device. Use this field to let Equinix know if you want your new device to be in a different location from any existing virtual device. This field is only meaningful for single devices.", "example": "ac8a8497-1b6e-42d1-9075-acf23a62ed50" } }, { "name": "clusterDetails", "description": "Cluster configuration details", "required": false, "schema": { "$ref": "#/components/schemas/ClusterDetails" } }, { "name": "primaryDeviceUuid", "description": "This field is mandatory if you are using this API to add a secondary device to an existing primary device.", "required": false, "schema": { "type": "string", "description": "This field is mandatory if you are using this API to add a secondary device to an existing primary device.", "example": "ac8a8497-1b6e-42d1-9075-acf23a62ed50" } }, { "name": "connectivity", "description": "Specifies the connectivity on the device. You can have INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. Private devices don't have ACLs or bandwidth.", "required": false, "schema": { "enum": [ "INTERNET-ACCESS", "PRIVATE", "INTERNET-ACCESS-WITH-PRVT-MGMT" ], "type": "string", "description": "Specifies the connectivity on the device. You can have INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. Private devices don't have ACLs or bandwidth.", "example": "INTERNET-ACCESS" } }, { "name": "channelPartner", "description": "The name of the channel partner.", "required": false, "schema": { "type": "string", "description": "The name of the channel partner.", "example": "SDCI" } }, { "name": "cloudInitFileId", "description": "The Id of a previously uploaded license or cloud_init file.", "required": false, "schema": { "type": "string", "description": "The Id of a previously uploaded license or cloud_init file.", "example": "2d732d49-7a00-4839-aeca-8a2ff89da691" } }, { "name": "purchaseOrderNumber", "description": "Purchase Order information will be included in your order confirmation email.", "required": false, "schema": { "type": "string", "description": "Purchase Order information will be included in your order confirmation email.", "example": "789065" } }, { "name": "orderReference", "description": "Enter a short name/number to identify this order on the invoice.", "required": false, "schema": { "type": "string", "description": "Enter a short name/number to identify this order on the invoice.", "example": "345678A" } }, { "name": "secondary", "description": "Request to create a secondary HA device", "required": false, "schema": { "$ref": "#/components/schemas/Secondary_20f9e0a2" } } ], "result": { "name": "network-edge_createVirtualDeviceByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update Device Draft", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_deleteDeviceACLByUuid", "summary": "Delete ACL template By Uuid", "description": "Deletes an ACL template. You must provide the unique Id of the ACL template as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique ID of an ACL template", "required": true, "schema": { "type": "string", "example": "be7ef79e-31e7-4769-be5b-e192496f48aa", "description": "Unique ID of an ACL template" } }, { "name": "accountUcmId", "description": "A reseller deleting an ACL template for a customer must pass the accountUcmId of the customer.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "A reseller deleting an ACL template for a customer must pass the accountUcmId of the customer." } } ], "result": { "name": "network-edge_deleteDeviceACLByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete ACL template By Uuid", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_deleteDeviceBackupByUuid", "summary": "Delete Backup of Device", "description": "Deletes a backup by its unique ID. Authorization checks are performed on users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id a backup", "required": true, "schema": { "type": "string", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b", "description": "Unique Id a backup" } } ], "result": { "name": "network-edge_deleteDeviceBackupByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Backup of Device", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_deleteDeviceLinkGroupByUuid", "summary": "Delete Device Link By Uuid", "description": "This method deletes a device link group. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Link-Groups-and-Connections" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of a device link group.", "required": true, "schema": { "type": "string", "example": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567", "description": "Unique Id of a device link group." } } ], "result": { "name": "network-edge_deleteDeviceLinkGroupByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Device Link By Uuid", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_deleteVirtualDeviceByUuid", "summary": "Delete Virtual Device By Uuid", "description": "Delete a virtual device. For some device types (e.g., Palo Alto devices), you also need to provide a deactivation key as a body parameter. For a device pair, the deleteRedundantDevice field must be marked True so we delete both the devices simultaneously.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of a Virtual Device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a Virtual Device" } }, { "name": "deleteRedundantDevice", "description": "Optional parameter in case you have a secondary device. As both the primary and secondary devices are deleted simultaneously, this field must be marked True so we delete both the devices simultaneously.", "required": false, "schema": { "type": "boolean", "default": false, "example": false, "description": "Optional parameter in case you have a secondary device. As both the primary and secondary devices are deleted simultaneously, this field must be marked True so we delete both the devices simultaneously." } }, { "name": "deactivationKey", "description": "If you do not provide a deactivation key for a Palo Alto BYOL device, you must contact your vendor to release the license.", "required": false, "schema": { "type": "string", "description": "If you do not provide a deactivation key for a Palo Alto BYOL device, you must contact your vendor to release the license.", "example": "8dfbd5ba3610234d9e550032603cc34762af140533e2c1de0111d3451d16eefd" } }, { "name": "secondary", "description": "Request to delete a secondary virtual device", "required": false, "schema": { "type": "object", "properties": { "deactivationKey": { "type": "string", "description": "Object that holds the secondary deactivation key for a redundant device. If you do not provide a deactivation key for a Palo Alto BYOL device, you must contact your vendor to release the license.", "example": "8dfbd5ba3610234d9e550032603cc34762af140533e2c1de0111d3451d16eefd" } }, "description": "Request to delete a secondary virtual device" } } ], "result": { "name": "network-edge_deleteVirtualDeviceByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete Virtual Device By Uuid", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_downloadDeviceBackupByUuid", "summary": "Download a Backup", "description": "Downloads the backup of a device by its backup ID. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique ID of a backup", "required": true, "schema": { "type": "string", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b", "description": "Unique ID of a backup" } } ], "result": { "name": "network-edge_downloadDeviceBackupByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "string", "description": "The configuration of the device in a string format.", "example": "Current configuration 9531 bytes", "x-fastmcp-top-level-schema": "BackupDownloadResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Download a Backup", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getAccountsWithStatus", "summary": "List Accounts by Metro", "description": "Gets accounts by metro. You must have an account in a metro to create a virtual device there. To create an account go to \"accountCreateUrl\".\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "metro", "description": "Metro region for which you want to check your account status", "required": true, "schema": { "type": "string", "example": "SV", "description": "Metro region for which you want to check your account status" } }, { "name": "accountUcmId", "description": "Unique ID of an account", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "Unique ID of an account" } } ], "result": { "name": "network-edge_getAccountsWithStatusResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "accountCreateUrl": { "type": "string", "description": "The URL to create a new account", "example": "https://customerportal.equinix.com" }, "data": { "type": "array", "items": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Account name", "example": "nfv1" }, "accountNumber": { "type": "integer", "description": "Account number", "example": 2252619 }, "accountUcmId": { "type": "string", "description": "Account UCM ID", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649" }, "accountStatus": { "enum": [ "ACTIVE", "PENDING", "SUSPENDED" ], "type": "string", "description": "Account status", "example": "ACTIVE" }, "metros": { "type": "array", "items": { "type": "string", "example": "DA" }, "description": "An array of metros where the account is valid" }, "creditHold": { "type": "boolean", "description": "Whether the account has a credit hold. You cannot use an account on credit hold to create a device.", "example": false }, "referenceId": { "type": "string", "description": "referenceId", "example": "null" } }, "description": "Details of a metro account" }, "description": "List of metro accounts" }, "errorMessage": { "type": "string", "description": "Error message", "example": "Invalid input" }, "errorCode": { "type": "string", "description": "Error code", "example": "EQ-4001530" }, "pagination": { "$ref": "#/components/schemas/PaginationResponse" } }, "description": "Paginated response for metro accounts", "x-fastmcp-top-level-schema": "PageResponseMetroAccountResponse" } }, "x-mcp-annotations": { "title": "List Accounts by Metro", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getAgreementStatus", "summary": "Get Agreement Status", "description": "Call this API to find out the status of your agreement, whether it is valid or not, or to just read the agreement terms.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Unique identifier of the customer account.", "required": false, "schema": { "type": "string", "example": "123456", "description": "Unique identifier of the customer account." } } ], "result": { "name": "network-edge_getAgreementStatusResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "isValid" ], "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Error message if agreement is invalid", "example": "null" }, "isValid": { "type": "boolean", "description": "Whether the agreement is valid", "example": true }, "terms": { "type": "string", "description": "Agreement terms", "example": "null" }, "termsVersionID": { "type": "string", "description": "Agreement terms version ID", "example": "null" } }, "x-fastmcp-top-level-schema": "AgreementStatusResponse" } }, "x-mcp-annotations": { "title": "Get Agreement Status", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getAllowedInterfaces", "summary": "List Allowed Interfaces", "description": "Returns the interface details for a device type with a chosen configuration. You must pass the device type as the path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "deviceType", "description": "Device type code (e.g., C8000V)", "required": true, "schema": { "enum": [ "C8000V", "C8000V-SDWAN", "PA-VM", "ASAV", "CGUARD", "FG-VM", "MERAKI-VMX", "PRISMA-SDWAN", "INFOBLOX", "AVIATRIX_EDGE", "VSRX", "ARISTA-ROUTER", "EDGECONNECT-SDWAN", "VERSA_SDWAN", "NGINX", "BLUECAT", "VYOS-ROUTER", "FG-SDWAN", "BLUECAT-EDGE-SERVICE-POINT", "F5XC", "6WIND-VSR", "VSRX-SDWAN", "FORTIGATE_VM" ], "type": "string", "description": "Device type code (e.g., C8000V)", "example": "PA-VM" } }, { "name": "deviceManagementType", "description": "Device management type. SELF-CONFIGURED", "required": true, "schema": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "example": "SELF-CONFIGURED", "description": "Device management type. SELF-CONFIGURED" } }, { "name": "mode", "description": "License mode, either Subscription or BYOL.", "required": false, "schema": { "enum": [ "Subscription", "BYOL" ], "type": "string", "example": "Subscription", "description": "License mode, either Subscription or BYOL." } }, { "name": "cluster", "description": "Whether you want a cluster device.", "required": false, "schema": { "type": "boolean", "example": false, "description": "Whether you want a cluster device." } }, { "name": "sdwan", "description": "Whether you want an SD-WAN device.", "required": false, "schema": { "type": "boolean", "example": false, "description": "Whether you want an SD-WAN device." } }, { "name": "connectivity", "description": "Type of connectivity you want. INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. PRIVATE devices do not have ACLs or bandwidth.", "required": false, "schema": { "enum": [ "INTERNET-ACCESS", "PRIVATE", "INTERNET-ACCESS-WITH-PRVT-MGMT" ], "type": "string", "example": "INTERNET-ACCESS", "description": "Type of connectivity you want. INTERNET-ACCESS, PRIVATE, or INTERNET-ACCESS-WITH-PRVT-MGMT. PRIVATE devices do not have ACLs or bandwidth." } }, { "name": "core", "description": "The desired number of cores.", "required": false, "schema": { "type": "integer", "example": 4, "description": "The desired number of cores." } }, { "name": "memory", "description": "Desired memory.", "required": false, "schema": { "type": "integer", "example": 4, "description": "Desired memory." } }, { "name": "unit", "description": "Unit of memory. GB or MB.", "required": false, "schema": { "type": "string", "example": "GB", "description": "Unit of memory. GB or MB." } }, { "name": "flavor", "description": "Flavor of device.", "required": false, "schema": { "type": "string", "example": "small", "description": "Flavor of device." } }, { "name": "version", "description": "Version.", "required": false, "schema": { "type": "string", "example": "17.06.01", "description": "Version." } }, { "name": "softwarePkg", "description": "Software package.", "required": false, "schema": { "type": "string", "example": "SEC", "description": "Software package." } } ], "result": { "name": "network-edge_getAllowedInterfacesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "interfaceProfiles": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "number", "description": "Allowed interface count", "example": 10.0 }, "interfaces": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the interface", "example": "ethernet1/1" }, "description": { "type": "string", "description": "Description of the interface", "example": "DATA Interface" }, "interfaceId": { "type": "string", "description": "Interface Id.", "example": "2" }, "status": { "enum": [ "AVAILABLE", "UNAVAILABLE", "ASSIGNED" ], "type": "string", "description": "Status of the interface.", "example": "AVAILABLE" } }, "description": "Detailed information about an interface" }, "description": "List of interfaces in this profile" }, "default": { "type": "boolean", "description": "Whether this will be the default interface count if you do not provide a number.", "example": true } }, "description": "Details of an allowed interface profile" }, "description": "List of allowed interface profiles" } }, "description": "Response containing allowed interface profiles", "x-fastmcp-top-level-schema": "AllowedInterfaceResponse" } }, "x-mcp-annotations": { "title": "List Allowed Interfaces", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDetailsOfBackupsByUuid", "summary": "Get Backups of Device By Uuid", "description": "Returns the details of a backup by its unique ID. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique ID of a backup", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique ID of a backup" } } ], "result": { "name": "network-edge_getDetailsOfBackupsByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique Id of the device backup.", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b" }, "name": { "type": "string", "description": "The name of the backup.", "example": "My New Backup" }, "version": { "type": "string", "description": "Version of the device", "example": "16.09.02" }, "type": { "enum": [ "CONFIG" ], "type": "string", "description": "The type of backup.", "example": "CONFIG" }, "status": { "enum": [ "COMPLETED", "FAILED", "IN_PROGRESS" ], "type": "string", "description": "The status of the backup.", "example": "COMPLETED" }, "createdBy": { "type": "string", "description": "Created by.", "example": "cust0001" }, "lastUpdatedDateTime": { "type": "string", "description": "Last updated date.", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "downloadUrl": { "type": "string", "description": "URL where you can download the backup.", "example": "/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download" }, "deleteAllowed": { "type": "boolean", "description": "Whether or not you can delete the backup.", "example": true }, "restores": { "$ref": "#/components/schemas/Restores" }, "deviceUuid": { "type": "string", "description": "Unique Id of the device", "example": "78fb5675-5c3f-4275-adba-0c9e3c26c78c" } }, "x-fastmcp-top-level-schema": "DeviceBackupInfoVerbose" } }, "x-mcp-annotations": { "title": "Get Backups of Device By Uuid", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceACLTemplate", "summary": "Get ACL Templates", "description": "Returns all ACL templates. The ACL templates list the networks that require access to the device.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page. It is the starting point of the collection returned from the server." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } }, { "name": "accountUcmId", "description": "Unique ID of the account. A reseller querying for the ACLs of a customer should input the accountUcmId of the customer.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "Unique ID of the account. A reseller querying for the ACLs of a customer should input the accountUcmId of the customer." } }, { "name": "projectIds", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter" } } ], "result": { "name": "network-edge_getDeviceACLTemplateResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_c1a3ad9b" }, "description": "Array of available ACL templates" } }, "x-fastmcp-top-level-schema": "GetACLTemplateResponse" } }, "x-mcp-annotations": { "title": "Get ACL Templates", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceBackups", "summary": "Get Backups of Device", "description": "Returns the backups of a virtual device. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "projectIds", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter" } }, { "name": "virtualDeviceUuid", "description": "Unique ID of a virtual device", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique ID of a virtual device" } }, { "name": "status", "description": "An array of status values", "required": false, "schema": { "enum": [ "COMPLETED", "FAILED", "IN_PROGRESS" ], "type": "string", "example": "COMPLETED", "description": "An array of status values" } }, { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page. It is the starting point of the collection returned from the server." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } } ], "result": { "name": "network-edge_getDeviceBackupsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique Id of the device backup.", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b" }, "name": { "type": "string", "description": "The name of the backup.", "example": "My New Backup" }, "version": { "type": "string", "description": "Version of the device", "example": "16.09.02" }, "type": { "enum": [ "CONFIG" ], "type": "string", "description": "The type of backup.", "example": "CONFIG" }, "status": { "enum": [ "COMPLETED", "FAILED", "IN_PROGRESS" ], "type": "string", "description": "The status of the backup.", "example": "COMPLETED" }, "createdBy": { "type": "string", "description": "Created by.", "example": "cust0001" }, "lastUpdatedDateTime": { "type": "string", "description": "Last updated date.", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "downloadUrl": { "type": "string", "description": "URL where you can download the backup.", "example": "/nfv/v1/deviceBackups/02cd28c5-3e4b-44ff-ad86-bb01eb3e5863/download" }, "deleteAllowed": { "type": "boolean", "description": "Whether or not you can delete the backup.", "example": true }, "restores": { "$ref": "#/components/schemas/Restores" }, "deviceUuid": { "type": "string", "description": "Unique Id of the device", "example": "78fb5675-5c3f-4275-adba-0c9e3c26c78c" } } }, "description": "Array of available backups" } }, "x-fastmcp-top-level-schema": "GetDeviceBackupsResponse" } }, "x-mcp-annotations": { "title": "Get Backups of Device", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceLinkGroupByUUID", "summary": "Get Device Link By Uuid", "description": "This API will return a device link by its unique Id. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Link-Groups-and-Connections" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of a device link group.", "required": true, "schema": { "type": "string", "example": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567", "description": "Unique Id of a device link group." } } ], "result": { "name": "network-edge_getDeviceLinkGroupByUUIDResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique Id of the linked group.", "example": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567" }, "groupName": { "type": "string", "description": "The name of the linked group", "example": "my-new-link" }, "subnet": { "type": "string", "description": "Subnet of the link group.", "example": "10.0.0.0/27" }, "redundancyType": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Whether the connection is through Fabric's primary or secondary port.", "example": "SECONDARY" }, "status": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "description": "Status of the linked group", "example": "PROVISIONING" }, "createdBy": { "type": "string", "description": "Created by username.", "example": "nfv-sit1" }, "createdDateTime": { "type": "string", "description": "Created date.", "format": "date-time", "example": "2019-09-15T10:30:31Z" }, "lastUpdatedBy": { "type": "string", "description": "Last updated by user", "example": "reg2-acc1" }, "lastUpdatedDateTime": { "type": "string", "description": "Last updated date", "format": "date-time", "example": "2019-09-16T10:30:31Z" }, "metroLinks": { "$ref": "#/components/schemas/MetroLinks_a8984f74" }, "linkDevices": { "$ref": "#/components/schemas/LinkDevices_e04b20a5" } }, "x-fastmcp-top-level-schema": "DeviceLinkGroup" } }, "x-mcp-annotations": { "title": "Get Device Link By Uuid", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceLinkGroups", "summary": "Get Device Links", "description": "This method returns device links. You can link any two or more devices that are registered and provisioned.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Link-Groups-and-Connections" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "projectIds", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter" } }, { "name": "metro", "description": "Metro Code", "required": false, "schema": { "type": "string", "example": "SV", "description": "Metro Code" } }, { "name": "virtualDeviceUuid", "description": "Unique Id of a virtual device.", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a virtual device." } }, { "name": "accountUcmId", "description": "Unique Id of the account. A reseller querying for a customer's link groups can pass the accountUcmId of the customer's account.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "Unique Id of the account. A reseller querying for a customer's link groups can pass the accountUcmId of the customer's account." } }, { "name": "groupUuid", "description": "Unique Id of a link group", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a link group" } }, { "name": "groupName", "description": "The name of a link group", "required": false, "schema": { "type": "string", "example": "linkGroup", "description": "The name of a link group" } }, { "name": "offset", "description": "Specifies where to start a page.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } } ], "result": { "name": "network-edge_getDeviceLinkGroupsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique Id of the linked group.", "example": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567" }, "groupName": { "type": "string", "description": "The name of the linked group", "example": "my-new-link" }, "subnet": { "type": "string", "description": "Subnet of the link group.", "example": "10.0.0.0/27" }, "redundancyType": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Whether the connection is through Fabric's primary or secondary port.", "example": "SECONDARY" }, "status": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "description": "Status of the linked group", "example": "PROVISIONING" }, "createdBy": { "type": "string", "description": "Created by username.", "example": "nfv-sit1" }, "createdDateTime": { "type": "string", "description": "Created date.", "format": "date-time", "example": "2019-09-15T10:30:31Z" }, "lastUpdatedBy": { "type": "string", "description": "Last updated by user", "example": "reg2-acc1" }, "lastUpdatedDateTime": { "type": "string", "description": "Last updated date", "format": "date-time", "example": "2019-09-16T10:30:31Z" }, "metroLinks": { "$ref": "#/components/schemas/MetroLinks_a8984f74" }, "linkDevices": { "$ref": "#/components/schemas/LinkDevices_e04b20a5" } } }, "description": "Array of available links" } }, "x-fastmcp-top-level-schema": "GetLinksResponse" } }, "x-mcp-annotations": { "title": "Get Device Links", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceReloadByUuid", "summary": "List Device Reload History By Uuid", "description": "Returns the reload history of a device. Please send the unique Id of the device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUUID", "description": "Unique ID of a virtual device.", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique ID of a virtual device." } }, { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page. It is the starting point of the collection returned from the server." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } } ], "result": { "name": "network-edge_getDeviceReloadByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "type": "object", "properties": { "deviceUUID": { "type": "string", "description": "Unique Id of the device.", "example": "be7ef79e-31e7-4769-be5b-e192496f48aa" }, "status": { "enum": [ "SUCCESS", "FAILED", "IN_PROGRESS" ], "type": "string", "description": "The status of the reboot.", "example": "SUCCESS" }, "requestedBy": { "type": "string", "description": "Requested by", "example": "nfvsit01" }, "requestedDateTime": { "type": "string", "description": "Requested date", "format": "date-time", "example": "2020-10-03T19:41:17Z" }, "completiondDateTime": { "type": "string", "description": "Completion date", "format": "date-time", "example": "2020-10-03T19:41:17Z" } } }, "description": "Array of available reload history" } }, "x-fastmcp-top-level-schema": "GetDeviceReloadResponse" } }, "x-mcp-annotations": { "title": "List Device Reload History By Uuid", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceTemplateByUuid", "summary": "Get ACL Template By Uuid", "description": "Returns details of any existing template. You must provide the unique ID of an existing template as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of an ACL template", "required": true, "schema": { "type": "string", "example": "be7ef79e-31e7-4769-be5b-e192496f48aa", "description": "Unique Id of an ACL template" } } ], "result": { "name": "network-edge_getDeviceTemplateByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ACL template.", "example": "New template" }, "uuid": { "type": "string", "description": "The unique Id of the ACL template.", "example": "be7ef79e-31e7-4769-be5b-e192496f48aa" }, "description": { "type": "string", "description": "The description of the ACL template.", "example": "My description" }, "inboundRules": { "$ref": "#/components/schemas/InboundRules_8fddabb6" }, "virtualDeviceDetails": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the virtual device associated with this template.", "example": "Test Device" }, "uuid": { "type": "string", "description": "The unique Id of the virtual device associated with this template.", "example": "ce7ef79e-31e7-4769-be5b-e192496f48ab" }, "interfaceType": { "enum": [ "MGMT", "WAN" ], "type": "string", "description": "Interface type, WAN or MGMT.", "example": "WAN" }, "aclStatus": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "description": "Device ACL status", "example": "PROVISIONING" } } }, "description": "The array of devices associated with this ACL template" }, "createdBy": { "type": "string", "description": "Created by", "example": "nfvsit01" }, "createdDateTime": { "type": "string", "description": "Created date", "format": "date-time", "example": "2020-10-03T19:41:17Z" } }, "x-fastmcp-top-level-schema": "ACLTemplateDetailsResponse" } }, "x-mcp-annotations": { "title": "Get ACL Template By Uuid", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceTemplatesByUuid", "summary": "Get ACL of Virtual Device", "description": "Returns the details of ACL templates associated with a device. You must provide the unique ID of an existing virtual device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUuid", "description": "Unique Id of a virtual device.", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a virtual device." } } ], "result": { "name": "network-edge_getDeviceTemplatesByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "aclTemplate": { "$ref": "#/components/schemas/DataItem_c1a3ad9b" }, "mgmtAclTemplate": { "$ref": "#/components/schemas/DataItem_c1a3ad9b" } }, "x-fastmcp-top-level-schema": "InitialDeviceACLResponse" } }, "x-mcp-annotations": { "title": "Get ACL of Virtual Device", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDeviceUpgradeByUuid", "summary": "Get Device Upgrade History", "description": "Returns the upgrade history of a device. Please send the unique Id of the device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUuid", "description": "Unique ID of a virtual device.", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique ID of a virtual device." } }, { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page. It is the starting point of the collection returned from the server." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } } ], "result": { "name": "network-edge_getDeviceUpgradeByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique Id of the upgrade.", "example": "be7ef79e-31e7-4769-be5b-e192496f48aa" }, "virtualDeviceUuid": { "type": "string", "description": "Unique Id of the device.", "example": "8ed6ffcb-cef5-4801-83a3-2aa2b6c682f0" }, "status": { "enum": [ "REQUEST_ACCEPTED", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCELLED" ], "type": "string", "description": "The status of the upgrade. REQUEST_ACCEPTED, IN_PROGRESS, SUCCESS, FAILED, CANCELLED", "example": "SUCCESS" }, "requestedDateTime": { "type": "string", "description": "Requested date", "format": "date-time", "example": "2020-10-03T19:41:17Z" }, "completiondDateTime": { "type": "string", "description": "Completion date", "format": "date-time", "example": "2020-10-03T19:41:17Z" }, "requestedBy": { "type": "string", "description": "Requested by.", "example": "eqxnfvuser1" } } }, "description": "Array of available upgrade history" } }, "x-fastmcp-top-level-schema": "GetDeviceUpgradeResponse" } }, "x-mcp-annotations": { "title": "Get Device Upgrade History", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDownloadImageByDeviceType", "summary": "Download an Image", "description": "Returns a link to download image. You need to provide a device type and version as path parameters.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Download-Image" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "deviceType", "description": "Device type code (e.g., C8000V)", "required": true, "schema": { "$ref": "#/components/schemas/DeviceTypeCode" } }, { "name": "version", "description": "Version", "required": true, "schema": { "type": "string", "example": "17.06.01", "description": "Version" } } ], "result": { "name": "network-edge_getDownloadImageByDeviceTypeResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "downloadLink": { "type": "string", "description": "The link to download the image", "example": "https://mb2lxfsprod.equinix.com/owncloud/index.php/s/7BTqXaZbggTURBO/download" } }, "x-fastmcp-top-level-schema": "PostDownloadImageResponse" } }, "x-mcp-annotations": { "title": "Download an Image", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getDownloadableImagesByDeviceType", "summary": "Get Downloadable Images", "description": "Returns the downloadable images of a device type. Pass any device type as a path parameter to get the list of downloadable images.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Download-Image" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "deviceType", "description": "Device type code (e.g., C8000V)", "required": true, "schema": { "$ref": "#/components/schemas/DeviceTypeCode" } } ], "result": { "name": "network-edge_getDownloadableImagesByDeviceTypeResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique Id of the downloadable link.", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b" }, "deviceType": { "$ref": "#/components/schemas/DeviceTypeCode" }, "imageName": { "type": "string", "description": "Name of the image.", "example": "CiscoSyst-C8000VCon-17.11.01a-3270" }, "version": { "type": "string", "description": "Device version", "example": "17.11.01a" } }, "description": "Details of a downloadable image" }, "x-fastmcp-top-level-schema": "GetDownloadableImageResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get Downloadable Images", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getInterfaceStatisticsByUuid", "summary": "Get Interface Statistics", "description": "Returns the throughput statistics of a device interface. Pass the unique Id of the device and the interface Id as path parameters.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUuid", "description": "Unique Id of a device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a device" } }, { "name": "interfaceId", "description": "Interface Id", "required": true, "schema": { "type": "string", "example": "1", "description": "Interface Id" } }, { "name": "startDateTime", "description": "Start time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ)", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2023-11-10T19:06:06Z", "description": "Start time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ)" } }, { "name": "endDateTime", "description": "End time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ)", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2023-11-17T19:06:06Z", "description": "End time of the duration for which you want stats. (YYYY-MM-DDThh:mm:ssZ)" } } ], "result": { "name": "network-edge_getInterfaceStatisticsByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "stats": { "type": "object", "properties": { "startDateTime": { "type": "string", "description": "Start time of the duration for which you want stats.", "format": "date-time", "example": "2023-11-10T19:06:06Z" }, "endDateTime": { "type": "string", "description": "End time of the duration for which you want stats.", "format": "date-time", "example": "2023-11-17T19:06:06Z" }, "unit": { "type": "string", "description": "Unit.", "example": "Mbps" }, "inbound": { "$ref": "#/components/schemas/Inbound_69c91658" }, "outbound": { "$ref": "#/components/schemas/Inbound_69c91658" } }, "description": "Detailed interface statistics" } }, "x-fastmcp-top-level-schema": "InterfaceStatsObject" } }, "x-mcp-annotations": { "title": "Get Interface Statistics", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getMetros", "summary": "List Available Metros", "description": "Gets the available list of metros where NE platform is available. Please note that an account must be created for each country where virtual devices are being purchased.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "region", "description": "Name of the region for which you want metros (e.g., AMER)", "required": false, "schema": { "type": "string", "example": "AMER", "description": "Name of the region for which you want metros (e.g., AMER)" } }, { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page. It is the starting point of the collection returned from the server." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } } ], "result": { "name": "network-edge_getMetrosResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "type": "object", "properties": { "metroCode": { "type": "string", "description": "Metro code", "example": "SV" }, "metroDescription": { "type": "string", "description": "Metro description", "example": "Silicon Valley" }, "region": { "type": "string", "description": "Region within which the metro is located", "example": "AMER" }, "clusterSupported": { "type": "boolean", "description": "Whether this metro supports cluster devices", "example": false } }, "description": "Metro details" }, "description": "Array of available metros" } }, "x-fastmcp-top-level-schema": "GetMetrosResponse" } }, "x-mcp-annotations": { "title": "List Available Metros", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getNotifications", "summary": "Get Downtime Notifications", "description": "Returns all planned and unplanned downtime notifications related to APIs and infrastructure. Please pass a token in the header.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [], "result": { "name": "network-edge_getNotificationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "notificationType": { "enum": [ "PLANNED", "UNPLANNED" ], "type": "string", "description": "Type of notification, whether planned or unplanned.", "example": "PLANNED" }, "startDateTime": { "type": "string", "description": "Start of the downtime.", "format": "date-time", "example": "2019-08-27T17:30:00Z" }, "endDateTime": { "type": "string", "description": "End of the downtime.", "format": "date-time", "example": "2019-08-27T17:30:00Z" }, "impactedServices": { "type": "array", "items": { "type": "object", "properties": { "serviceName": { "type": "string", "description": "The name of the impacted service.", "example": "Device" }, "impact": { "type": "string", "description": "The type of impact, whether the impacted service is down or delayed.", "example": "Device" }, "serviceStartDateTime": { "type": "string", "description": "Start of the downtime of the service.", "format": "date-time", "example": "2019-08-27T17:30:00Z" }, "serviceEndDateTime": { "type": "string", "description": "End of the downtime of the service.", "format": "date-time", "example": "2019-08-27T17:30:00Z" }, "errorMessage": { "type": "string", "description": "Downtime message of the service.", "example": "Create device APIs are currently down." } }, "description": "Details of impacted services during downtime" }, "description": "An array of services impacted by the downtime." }, "additionalMessage": { "type": "string", "description": "Any additional messages.", "example": "Network Edge APIs are currently unavailable. Please try again later." } }, "description": "Details of a downtime notification", "x-fastmcp-top-level-schema": "DowntimeNotification" } }, "x-mcp-annotations": { "title": "Get Downtime Notifications", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getOrderSummary", "summary": "Get Order Summary", "description": "Gets the order summary as a printable pdf file. This API helps customers who have to go through a PO process at their end to make a purchase and need a formal quote\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Account number", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123456, "description": "Account number" } }, { "name": "metro", "description": "Metro", "required": false, "schema": { "type": "string", "example": "SV", "description": "Metro" } }, { "name": "vendorPackage", "description": "Vendor package", "required": false, "schema": { "enum": [ "VM02", "VM03", "NETWORK-ESSENTIALS" ], "type": "string", "example": "NETWORK-ESSENTIALS", "description": "Vendor package" } }, { "name": "licenseType", "description": "License type", "required": false, "schema": { "enum": [ "Subscription", "BYOL" ], "type": "string", "example": "Subscription", "description": "License type" } }, { "name": "softwarePackage", "description": "Software package", "required": false, "schema": { "type": "string", "example": "AX", "description": "Software package" } }, { "name": "throughput", "description": "Throughput", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "description": "Throughput" } }, { "name": "throughputUnit", "description": "Throughput unit", "required": false, "schema": { "type": "string", "example": "Mbps", "description": "Throughput unit" } }, { "name": "termLength", "description": "Term length (in months)", "required": false, "schema": { "type": "string", "example": "12", "description": "Term length (in months)" } }, { "name": "additionalBandwidth", "description": "Additional bandwidth (in Mbps)", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "description": "Additional bandwidth (in Mbps)" } }, { "name": "virtualDeviceUuid", "description": "Virtual device unique Id (only required if existing device is being modified)", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Virtual device unique Id (only required if existing device is being modified)" } }, { "name": "deviceManagementType", "description": "The device management type", "required": false, "schema": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "example": "SELF-CONFIGURED", "description": "The device management type" } }, { "name": "core", "description": "The number of cores", "required": false, "schema": { "type": "integer", "format": "int32", "example": 4, "description": "The number of cores" } }, { "name": "secondaryAccountNumber", "description": "Secondary account number (in case you have a device pair)", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123457, "description": "Secondary account number (in case you have a device pair)" } }, { "name": "secondaryMetro", "description": "Secondary metro (in case you have a device pair)", "required": false, "schema": { "type": "string", "example": "SV", "description": "Secondary metro (in case you have a device pair)" } }, { "name": "secondaryAdditionalBandwidth", "description": "Secondary additional bandwidth (in Mbps)", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "description": "Secondary additional bandwidth (in Mbps)" } }, { "name": "accountUcmId", "description": "Account unique ID", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "Account unique ID" } }, { "name": "orderingContact", "description": "Reseller customer username", "required": false, "schema": { "type": "string", "example": "cust0001", "description": "Reseller customer username" } } ], "result": { "name": "network-edge_getOrderSummaryResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": {} } }, "pagination": { "$ref": "#/components/schemas/PaginationResponse" } }, "x-fastmcp-top-level-schema": "PageResponse" } }, "x-mcp-annotations": { "title": "Get Order Summary", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getOrderTerms", "summary": "Get Order Terms", "description": "Retrieves the terms and conditions of orders. Please read the terms and conditions before placing an order.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [], "result": { "name": "network-edge_getOrderTermsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "terms": { "type": "string", "description": "Order terms", "example": "By clicking \"Accept\" you are agreeing to the terms and conditions of this Order on behalf of your Company. You are acknowledging that you have the full authority on behalf of your Company to enter into this online Order \"Order\" as governed by and incorporated by reference into the applicable Master Country Agreement, Interconnection Terms and Conditions, or other similar agreement agreed to between the Parties \"Agreement.\" Unless otherwise defined in this Order or if the context requires otherwise, all capitalized terms used in this Order shall have the meanings ascribed to them in the Agreement.‘Product(s)’ as used in this Order means all the products under this Order, including Licensed Space and/or Services (if any). The Initial Term is the term stated above, which commence on the date the Product(s) are delivered (“Effective Date”). After the Initial Term, the term will automatically renew for a period equal to the Initial Term unless either Party terminates this Order by providing written non-renewal notice 90 days prior to the end of the then-current term to the other Party in which event this Order will terminate at the end of the then-current term. For avoidance of doubt, the notice period for an Initial Term of one month is 30 days, rather than 90 days. This Order incorporates the Product Provider EULA provided by Equinix to the Customer in Attachment A of this Order and the Product Policies, which are attached as Exhibits to the Customer’s Interconnection Terms and Conditions. All Product(s) selected as part of this Order are subject to availability. Equinix, in its sole discretion, reserves the right to reject any handwritten or typed modification to this Agreement or any Order which is not mutually agreed to in writing. For purposes of this Order, the Parties hereby agree that the following ‘Price Increase Terms’ grid is not applicable to the Network Edge Service and is of no force or effect. If you have any questions regarding the terms of this Order, please contact your Equinix Sales Representative. A PRODUCT PROVIDER EULABy clicking \\\"Accept\\\" you are agreeing to the terms and conditions of this Order on behalf of your Company. You are acknowledging that you have the full authority on behalf of your Company to enter into this online Order (\\\"Order\\\") as governed by and incorporated by reference into the applicable Master Country Agreement, Interconnection Terms and Conditions, or other similar agreement agreed to between the Parties (\\\"Agreement\\\"). Unless otherwise defined in this Order or if the context requires otherwise, all capitalized terms used in this Order shall have the meanings ascribed to them in the Agreement.\\r\\n‘Product(s)’ as used in this Order means all the products under this Order, including Licensed Space and/or Services (if any). The Initial Term is the term stated above, which commence on the date the Product(s) are delivered (“Effective Date”). \\r\\n\\r\\nAfter the Initial Term, the term will automatically renew for a period equal to the Initial Term unless either Party terminates this Order by providing written non-renewal notice 90 days prior to the end of the then-current term to the other Party in which event this Order will terminate at the end of the then-current term. For the avoidance of doubt, the notice period for an Initial Term of one month is 30 days, rather than 90 days. \\r\\n\\r\\n\\r\\nThis Order incorporates the Product Provider EULA provided by Equinix to the Customer in Attachment A of this Order and the Product Policies, which are attached as Exhibits to the Customer’s Interconnection Terms and Conditions . All Product(s) selected as part of this Order are subject to availability.\\r\\n\\r\\nEquinix, in its sole discretion, reserves the right to reject any handwritten or typed modification to this Agreement or any Order which is not mutually agreed to in writing. For purposes of this Order, the Parties hereby agree that the following ‘Price Increase Terms’ grid is not applicable to the Network Edge Service and is of no force or effect. If you have any questions regarding the terms of this Order, please contact your Equinix Sales Representative. ATTACHMENT A PRODUCT PROVIDER EULA" } }, "description": "Response containing order terms", "x-fastmcp-top-level-schema": "OrderTermsResponse" } }, "x-mcp-annotations": { "title": "Get Order Terms", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getPublicKeys", "summary": "Get Public Keys", "description": "Returns the SSH public keys associated with this organization. If you are a reseller, please pass the account number of you customer to get the public keys.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "accountUcmId", "description": "This field is for resellers. Please pass the accountUcmId of your customer to get the public keys.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "This field is for resellers. Please pass the accountUcmId of your customer to get the public keys." } }, { "name": "projectIds", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8,3da0a663-20d9-4b8f-8c5d-d5cf706840c9", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter" } } ], "result": { "name": "network-edge_getPublicKeysResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique Id of the keyName and keyValue combination", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" }, "keyName": { "type": "string", "description": "Key name", "example": "myKeyName" }, "keyValue": { "type": "string", "description": "Key value", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname" }, "keyType": { "enum": [ "RSA", "DSA" ], "type": "string", "description": "Type of key, whether RSA or DSA", "example": "RSA" } }, "description": "Details of a public key" }, "description": "Array of available public keys" } }, "x-fastmcp-top-level-schema": "GetPublicKeysResponse" } }, "x-mcp-annotations": { "title": "Get Public Keys", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getVendorTerms", "summary": "Get Vendor Terms", "description": "Returns a link to a vendor's terms. The term \"vendor\" refers to the vendor of a virtual device on the Network Edge platform.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "vendorPackage", "description": "The vendor package code.", "required": false, "schema": { "enum": [ "VM02", "VM03", "NETWORK-ESSENTIALS" ], "type": "string", "example": "NETWORK-ESSENTIALS", "description": "The vendor package code." } }, { "name": "licenseType", "description": "The type of license (e.g., Subscription, BYOL).", "required": false, "schema": { "enum": [ "Subscription", "BYOL" ], "type": "string", "example": "Subscription", "description": "The type of license (e.g., Subscription, BYOL)." } } ], "result": { "name": "network-edge_getVendorTermsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "terms": { "type": "string", "description": "Vendor terms URL", "example": "https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html" } }, "description": "Response containing vendor terms", "x-fastmcp-top-level-schema": "VendorTermsResponse" } }, "x-mcp-annotations": { "title": "Get Vendor Terms", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getVirtualDeviceByUuid", "summary": "Get Virtual Device By Uuid", "description": "Returns the virtual device details of an existing device on the Network Edge platform. You must provide the unique ID of the existing device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "uuid", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "uuid" } } ], "result": { "name": "network-edge_getVirtualDeviceByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Account name", "example": "ABC INC" }, "accountNumber": { "type": "string", "description": "Account number", "example": "133911" }, "createdBy": { "type": "string", "description": "Created by user", "example": "cust0001" }, "createdDateTime": { "type": "string", "description": "Date and time of creation", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "deletedBy": { "type": "string", "description": "Deleted by user", "example": "cust0001" }, "deletedDateTime": { "type": "string", "description": "Date and time of deletion", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "deviceSerialNo": { "type": "string", "description": "Device serial number", "example": "53791666484" }, "deviceTypeCategory": { "enum": [ "ROUTER", "FIREWALL", "SDWAN" ], "type": "string", "description": "Device type category (e.g., ROUTER, FIREWALL)", "example": "ROUTER" }, "diverseFromDeviceName": { "type": "string", "description": "The name of a device that is in a location different from this device.", "example": "My-Other-Device" }, "diverseFromDeviceUuid": { "type": "string", "description": "The unique ID of a device that is in a location different from this device.", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b" }, "deviceTypeCode": { "$ref": "#/components/schemas/DeviceTypeCode" }, "deviceTypeName": { "$ref": "#/components/schemas/DeviceTypeCode" }, "expiry": { "type": "string", "description": "Expiry time", "example": "2019-02-07T00:00:00" }, "region": { "type": "string", "description": "Region", "example": "AMER" }, "deviceTypeVendor": { "enum": [ "CISCO", "PALO_ALTO_NETWORKS", "JUNIPER", "FORTINET", "ARISTA", "ARUBA", "F5", "BLUECAT", "ZSCALER", "CHECK_POINT", "VMWARE", "SILVER_PEAK", "VERSA_NETWORKS", "AVIATRIX" ], "type": "string", "description": "Device type vendor", "example": "CISCO" }, "hostName": { "type": "string", "description": "Host name", "example": "VR-SV-C8000V-cust0001-1" }, "uuid": { "type": "string", "description": "Device UUID", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" }, "lastUpdatedBy": { "type": "string", "description": "Last updated by user", "example": "cust0002" }, "lastUpdatedDateTime": { "type": "string", "description": "Date and time of last update", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "licenseFileId": { "type": "string", "description": "License file ID", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" }, "licenseName": { "type": "string", "description": "License name", "example": "Bring your own license" }, "licenseStatus": { "enum": [ "REGISTERED", "UNREGISTERED", "PENDING", "EXPIRED" ], "type": "string", "description": "License status", "example": "REGISTERED" }, "licenseType": { "enum": [ "BYOL", "SUB" ], "type": "string", "description": "License type (e.g., BYOL, SUB)", "example": "BYOL" }, "metroCode": { "type": "string", "description": "Metro code", "example": "SV" }, "metroName": { "type": "string", "description": "Metro name", "example": "Silicon Valley" }, "name": { "type": "string", "description": "Device name", "example": "AWS-Azure-Router-c8000v" }, "notifications": { "type": "array", "items": { "type": "string", "example": "test@equinix.com" }, "description": "List of notifications" }, "packageCode": { "type": "string", "description": "Package code", "example": "SEC" }, "packageName": { "type": "string", "description": "Package name", "example": "Security" }, "version": { "type": "string", "description": "Device version", "example": "16.09.02" }, "purchaseOrderNumber": { "type": "string", "description": "Purchase order number", "example": "PO1223" }, "redundancyType": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Redundancy type", "example": "PRIMARY" }, "redundantUuid": { "type": "string", "description": "Redundant device UUID", "example": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa67xx" }, "connectivity": { "type": "string", "description": "Connectivity type", "example": "INTERNET-ACCESS" }, "sshIpAddress": { "type": "string", "description": "SSH IP address", "example": "10.195.11.23" }, "sshIpFqdn": { "type": "string", "description": "SSH IP FQDN", "example": "test-device-168-201-97-149.eis.lab.equinix.com" }, "sshIpFqdnStatus": { "enum": [ "ASSIGNED", "UNASSIGNED" ], "type": "string", "description": "SSH IP FQDN status", "example": "ASSIGNED" }, "status": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "description": "Device status", "example": "PROVISIONED" }, "throughput": { "type": "integer", "description": "Throughput", "format": "int32", "example": 500 }, "throughputUnit": { "type": "string", "description": "Throughput unit", "example": "Mbps" }, "core": { "$ref": "#/components/schemas/Core" }, "pricingDetails": { "$ref": "#/components/schemas/PricingDetails" }, "interfaceCount": { "type": "integer", "example": 10 }, "deviceManagementType": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "description": "Device management type (e.g., SELF-CONFIGURED, EQUINIX-CONFIGURED)", "example": "EQUINIX-CONFIGURED" }, "plane": { "type": "string", "example": "PRIMARY" }, "userPublicKey": { "$ref": "#/components/schemas/UserPublicKey_2ffeec4b" }, "managementIp": { "type": "string", "example": "10.195.237.228/26" }, "managementGatewayIp": { "type": "string", "example": "10.195.237.254" }, "publicIp": { "type": "string", "example": "149.97.198.95/31" }, "publicGatewayIp": { "type": "string", "example": "149.97.198.94" }, "primaryDnsName": { "type": "string", "description": "Primary DNS name", "example": "4.0.0.53" }, "secondaryDnsName": { "type": "string", "description": "Secondary DNS name", "example": "129.250.35.250" }, "termLength": { "type": "string", "description": "Term length in months.", "example": "12" }, "newTermLength": { "type": "string", "description": "The term length effective upon the expiration of the current term.", "example": "24" }, "additionalBandwidth": { "type": "string", "description": "Additional bandwidth", "example": "200" }, "siteId": { "type": "string", "description": "Site ID", "example": "12345" }, "systemIpAddress": { "type": "string", "description": "System IP address", "example": "192.168.2.5" }, "vendorConfig": { "$ref": "#/components/schemas/VendorConfig_9949fa91" }, "interfaces": { "$ref": "#/components/schemas/Interfaces" }, "asn": { "type": "number", "description": "The ASN number.", "example": 1029.0 }, "channelPartner": { "type": "string", "description": "The name of the channel partner.", "example": "SDCI" } }, "description": "Detailed virtual device information", "x-fastmcp-top-level-schema": "VirtualDeviceDetailsResponse" } }, "x-mcp-annotations": { "title": "Get Virtual Device By Uuid", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getVirtualDeviceInterfacesByUuid", "summary": "Get Device Interfaces", "description": "Returns the status of the interfaces of a device. You must pass the unique Id of the device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "uuid", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "uuid" } } ], "result": { "name": "network-edge_getVirtualDeviceInterfacesByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/InterfacesItem" }, "x-fastmcp-top-level-schema": "GetVirtualDeviceInterfacesResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get Device Interfaces", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getVirtualDeviceTypes", "summary": "List Device Types", "description": "Returns device types (e.g., routers and firewalls) that can be launched on the NE platform.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "deviceTypeCode", "description": "Device type code (e.g., C8000V)", "required": false, "schema": { "$ref": "#/components/schemas/DeviceTypeCode" } }, { "name": "category", "description": "Category. One of FIREWALL, ROUTER or SD-WAN", "required": false, "schema": { "type": "string", "example": "ROUTER", "description": "Category. One of FIREWALL, ROUTER or SD-WAN" } }, { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page. It is the starting point of the collection returned from the server." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } }, { "name": "projectId", "description": "If projectId is different from default projectId, must pass a projectId parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "If projectId is different from default projectId, must pass a projectId parameter" } } ], "result": { "name": "network-edge_getVirtualDeviceTypesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualDeviceType" }, "description": "Array of available virtual device types" } }, "x-fastmcp-top-level-schema": "GetDeviceTypesResponse" } }, "x-mcp-annotations": { "title": "List Device Types", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_getVirtualDevices", "summary": "Get Virtual Devices", "description": "Returns all virtual devices available on the Network Edge platform.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "Specifies where to start a page. It is the starting point of the collection returned from the server.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "example": 0, "description": "Specifies where to start a page. It is the starting point of the collection returned from the server." } }, { "name": "limit", "description": "Specifies the page size.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20, "example": 20, "description": "Specifies the page size." } }, { "name": "metroCode", "description": "Two-letter metro code.", "required": false, "schema": { "type": "string", "example": "SV", "description": "Two-letter metro code." } }, { "name": "status", "description": "The status of the device.", "required": false, "schema": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "example": "PROVISIONED", "description": "The status of the device." } }, { "name": "showOnlySubCustomerDevices", "description": "Resellers may mark this Yes to see sub customer devices.", "required": false, "schema": { "type": "boolean", "example": false, "description": "Resellers may mark this Yes to see sub customer devices." } }, { "name": "accountUcmId", "description": "Unique ID of the account.", "required": false, "schema": { "type": "string", "example": "123456", "description": "Unique ID of the account." } }, { "name": "searchText", "description": "Enter text to fetch only matching device names", "required": false, "schema": { "type": "string", "example": "My-Device", "description": "Enter text to fetch only matching device names" } }, { "name": "sort", "description": "Sorts the output based on field names.", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "example": [ "name" ], "description": "Sorts the output based on field names." } }, { "name": "projectIds", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "If projectIds are different from default projectIds, must pass a projectIds parameter" } } ], "result": { "name": "network-edge_getVirtualDevicesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "pagination", "data" ], "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/PaginationResponse" }, "data": { "type": "array", "items": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Account name", "example": "ABC INC" }, "accountNumber": { "type": "string", "description": "Account number", "example": "133911" }, "createdBy": { "type": "string", "description": "Created by user", "example": "cust0001" }, "createdDateTime": { "type": "string", "description": "Date and time of creation", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "deletedBy": { "type": "string", "description": "Deleted by user", "example": "cust0001" }, "deletedDateTime": { "type": "string", "description": "Date and time of deletion", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "deviceSerialNo": { "type": "string", "description": "Device serial number", "example": "53791666484" }, "deviceTypeCategory": { "enum": [ "ROUTER", "FIREWALL", "SDWAN" ], "type": "string", "description": "Device type category (e.g., ROUTER, FIREWALL)", "example": "ROUTER" }, "diverseFromDeviceName": { "type": "string", "description": "The name of a device that is in a location different from this device.", "example": "My-Other-Device" }, "diverseFromDeviceUuid": { "type": "string", "description": "The unique ID of a device that is in a location different from this device.", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b" }, "deviceTypeCode": { "$ref": "#/components/schemas/DeviceTypeCode" }, "deviceTypeName": { "$ref": "#/components/schemas/DeviceTypeCode" }, "expiry": { "type": "string", "description": "Expiry time", "example": "2019-02-07T00:00:00" }, "region": { "type": "string", "description": "Region", "example": "AMER" }, "deviceTypeVendor": { "enum": [ "CISCO", "PALO_ALTO_NETWORKS", "JUNIPER", "FORTINET", "ARISTA", "ARUBA", "F5", "BLUECAT", "ZSCALER", "CHECK_POINT", "VMWARE", "SILVER_PEAK", "VERSA_NETWORKS", "AVIATRIX" ], "type": "string", "description": "Device type vendor", "example": "CISCO" }, "hostName": { "type": "string", "description": "Host name", "example": "VR-SV-C8000V-cust0001-1" }, "uuid": { "type": "string", "description": "Device UUID", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" }, "lastUpdatedBy": { "type": "string", "description": "Last updated by user", "example": "cust0002" }, "lastUpdatedDateTime": { "type": "string", "description": "Date and time of last update", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "licenseFileId": { "type": "string", "description": "License file ID", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" }, "licenseName": { "type": "string", "description": "License name", "example": "Bring your own license" }, "licenseStatus": { "enum": [ "REGISTERED", "UNREGISTERED", "PENDING", "EXPIRED" ], "type": "string", "description": "License status", "example": "REGISTERED" }, "licenseType": { "enum": [ "BYOL", "SUB" ], "type": "string", "description": "License type (e.g., BYOL, SUB)", "example": "BYOL" }, "metroCode": { "type": "string", "description": "Metro code", "example": "SV" }, "metroName": { "type": "string", "description": "Metro name", "example": "Silicon Valley" }, "name": { "type": "string", "description": "Device name", "example": "AWS-Azure-Router-c8000v" }, "notifications": { "type": "array", "items": { "type": "string", "example": "test@equinix.com" }, "description": "List of notifications" }, "packageCode": { "type": "string", "description": "Package code", "example": "SEC" }, "packageName": { "type": "string", "description": "Package name", "example": "Security" }, "version": { "type": "string", "description": "Device version", "example": "16.09.02" }, "purchaseOrderNumber": { "type": "string", "description": "Purchase order number", "example": "PO1223" }, "redundancyType": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Redundancy type", "example": "PRIMARY" }, "redundantUuid": { "type": "string", "description": "Redundant device UUID", "example": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa67xx" }, "connectivity": { "type": "string", "description": "Connectivity type", "example": "INTERNET-ACCESS" }, "sshIpAddress": { "type": "string", "description": "SSH IP address", "example": "10.195.11.23" }, "sshIpFqdn": { "type": "string", "description": "SSH IP FQDN", "example": "test-device-168-201-97-149.eis.lab.equinix.com" }, "sshIpFqdnStatus": { "enum": [ "ASSIGNED", "UNASSIGNED" ], "type": "string", "description": "SSH IP FQDN status", "example": "ASSIGNED" }, "status": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "description": "Device status", "example": "PROVISIONED" }, "throughput": { "type": "integer", "description": "Throughput", "format": "int32", "example": 500 }, "throughputUnit": { "type": "string", "description": "Throughput unit", "example": "Mbps" }, "core": { "$ref": "#/components/schemas/Core" }, "pricingDetails": { "$ref": "#/components/schemas/PricingDetails" }, "interfaceCount": { "type": "integer", "example": 10 }, "deviceManagementType": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "description": "Device management type (e.g., SELF-CONFIGURED, EQUINIX-CONFIGURED)", "example": "EQUINIX-CONFIGURED" }, "plane": { "type": "string", "example": "PRIMARY" }, "userPublicKey": { "$ref": "#/components/schemas/UserPublicKey_2ffeec4b" }, "managementIp": { "type": "string", "example": "10.195.237.228/26" }, "managementGatewayIp": { "type": "string", "example": "10.195.237.254" }, "publicIp": { "type": "string", "example": "149.97.198.95/31" }, "publicGatewayIp": { "type": "string", "example": "149.97.198.94" }, "primaryDnsName": { "type": "string", "description": "Primary DNS name", "example": "4.0.0.53" }, "secondaryDnsName": { "type": "string", "description": "Secondary DNS name", "example": "129.250.35.250" }, "termLength": { "type": "string", "description": "Term length in months.", "example": "12" }, "newTermLength": { "type": "string", "description": "The term length effective upon the expiration of the current term.", "example": "24" }, "additionalBandwidth": { "type": "string", "description": "Additional bandwidth", "example": "200" }, "siteId": { "type": "string", "description": "Site ID", "example": "12345" }, "systemIpAddress": { "type": "string", "description": "System IP address", "example": "192.168.2.5" }, "vendorConfig": { "$ref": "#/components/schemas/VendorConfig_9949fa91" }, "interfaces": { "$ref": "#/components/schemas/Interfaces" }, "asn": { "type": "number", "description": "The ASN number.", "example": 1029.0 }, "channelPartner": { "type": "string", "description": "The name of the channel partner.", "example": "SDCI" } }, "description": "Detailed virtual device information" }, "description": "Array of available virtual devices" } }, "x-fastmcp-top-level-schema": "GetDevicesResponse" } }, "x-mcp-annotations": { "title": "Get Virtual Devices", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_pingDeviceByUuid", "summary": "Ping Virtual Device", "description": "Pings a virtual device to ensure it's reachable. At this point, you can only ping a few SELF-CONFIGURED devices.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Virtual Device unique Id", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Virtual Device unique Id" } } ], "result": { "name": "network-edge_pingDeviceByUuidResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Ping response message.", "example": "The device is reachable." } }, "x-fastmcp-top-level-schema": "PingResponse" } }, "x-mcp-annotations": { "title": "Ping Virtual Device", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_postPublicKey", "summary": "Create Public Key", "description": "Creates a public key. If you are a reseller, pass the account number of your customer to create a key-name and key-value pair.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "keyName", "description": "Key name", "required": true, "schema": { "type": "string", "description": "Key name", "example": "myKeyName" } }, { "name": "keyValue", "description": "Key value", "required": true, "schema": { "type": "string", "description": "Key value", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname" } }, { "name": "keyType", "description": "Key type, whether RSA or DSA. Default is RSA.", "required": false, "schema": { "enum": [ "RSA", "DSA" ], "type": "string", "description": "Key type, whether RSA or DSA. Default is RSA.", "example": "RSA" } } ], "result": { "name": "network-edge_postPublicKeyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique Id of the keyName and keyValue combination", "example": "877a3aa2-c49a-4af1-98a6-007424e737ae" }, "keyName": { "type": "string", "description": "Key name", "example": "myKeyName" }, "keyValue": { "type": "string", "description": "Key value", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC5kHcagDZ7utPan4DHWUvoJxwz/DISRFwZdpMhslhZRI+6dGOC8mJn42SlSUAUtkt8Qyl4HipPK7Xh6oGj70Iba1a9pDcURYTYcqWFBEhcdDsMnH1CICmvVdsILehFtiS3X0J1JhwmWQI/7ll3QOk8fLgWCz3idlYJqtMs8Gz/6Q== noname" }, "keyType": { "enum": [ "RSA", "DSA" ], "type": "string", "description": "Type of key, whether RSA or DSA", "example": "RSA" } }, "description": "Details of a public key", "x-fastmcp-top-level-schema": "PublicKeyResponse" } }, "x-mcp-annotations": { "title": "Create Public Key", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_restoreDeviceBackupByUuid", "summary": "Restores a backup", "description": "Restores any backup of a device. Authorization checks are performed on users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique ID of a backup", "required": true, "schema": { "type": "string", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b", "description": "Unique ID of a backup" } }, { "name": "name", "description": "The name of backup.", "required": true, "schema": { "type": "string", "description": "The name of backup.", "example": "My New Backup" } } ], "result": { "name": "network-edge_restoreDeviceBackupByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Restores a backup", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_retrievePrice", "summary": "Calculate Price", "description": "Returns the price of a virtual device and license based on account number and other fields. Please note that the listed price does not include the price of any optional features added to the device, some of which are charged.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Account number", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123456, "description": "Account number" } }, { "name": "metro", "description": "Metro", "required": false, "schema": { "type": "string", "example": "SV", "description": "Metro" } }, { "name": "vendorPackage", "description": "Vendor package", "required": false, "schema": { "enum": [ "VM02", "VM03", "NETWORK-ESSENTIALS" ], "type": "string", "example": "NETWORK-ESSENTIALS", "description": "Vendor package" } }, { "name": "licenseType", "description": "License type", "required": false, "schema": { "enum": [ "Subscription", "BYOL" ], "type": "string", "example": "Subscription", "description": "License type" } }, { "name": "softwarePackage", "description": "Software package", "required": false, "schema": { "type": "string", "example": "AX", "description": "Software package" } }, { "name": "throughput", "description": "Throughput", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "description": "Throughput" } }, { "name": "throughputUnit", "description": "Throughput unit", "required": false, "schema": { "type": "string", "example": "Mbps", "description": "Throughput unit" } }, { "name": "termLength", "description": "Term length (in months)", "required": false, "schema": { "type": "string", "example": "12", "description": "Term length (in months)" } }, { "name": "additionalBandwidth", "description": "Additional bandwidth (in Mbps)", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "description": "Additional bandwidth (in Mbps)" } }, { "name": "virtualDeviceUuid", "description": "Virtual device unique Id (only required if existing device is being modified)", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Virtual device unique Id (only required if existing device is being modified)" } }, { "name": "deviceManagementType", "description": "The device management type", "required": false, "schema": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "example": "SELF-CONFIGURED", "description": "The device management type" } }, { "name": "core", "description": "The number of cores", "required": false, "schema": { "type": "integer", "format": "int32", "example": 4, "description": "The number of cores" } }, { "name": "secondaryAccountNumber", "description": "The secondary account number (for HA)", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123457, "description": "The secondary account number (for HA)" } }, { "name": "secondaryMetro", "description": "Secondary metro (for HA)", "required": false, "schema": { "type": "string", "example": "SV", "description": "Secondary metro (for HA)" } }, { "name": "secondaryAdditionalBandwidth", "description": "Secondary additional bandwidth (in Mbps for HA)", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100, "description": "Secondary additional bandwidth (in Mbps for HA)" } }, { "name": "accountUcmId", "description": "Account unique ID", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "Account unique ID" } }, { "name": "orderingContact", "description": "Reseller customer username", "required": false, "schema": { "type": "string", "example": "cust0001", "description": "Reseller customer username" } } ], "result": { "name": "network-edge_retrievePriceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "primary": { "$ref": "#/components/schemas/Primary_7adceb2c" }, "secondary": { "$ref": "#/components/schemas/Primary_7adceb2c" }, "termLength": { "type": "string", "description": "Term length in months.", "example": "24" } }, "description": "Composite pricing response for primary and secondary devices", "x-fastmcp-top-level-schema": "CompositePriceResponse" } }, "x-mcp-annotations": { "title": "Calculate Price", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_updateAdditionalBandwidthByUuid", "summary": "Update Additional Bandwidth of Virtual Device", "description": "You can use this method to change or add additional bandwidth to a virtual device.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "The unique Id of a virtual device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "The unique Id of a virtual device" } }, { "name": "additionalBandwidth", "description": "Additional bandwidth in Mbps.", "required": false, "schema": { "type": "integer", "description": "Additional bandwidth in Mbps.", "example": 100 } } ], "result": { "name": "network-edge_updateAdditionalBandwidthByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update Additional Bandwidth of Virtual Device", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_updateDeviceACLTemplateByUuid", "summary": "Update ACL Template By Uuid", "description": "Updates an ACL template. You must pass the unique Id of the ACL template as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique ID of an ACL template", "required": true, "schema": { "type": "string", "example": "be7ef79e-31e7-4769-be5b-e192496f48aa", "description": "Unique ID of an ACL template" } }, { "name": "name", "description": "The ACL template name.", "required": true, "schema": { "type": "string", "description": "The ACL template name.", "example": "Test Template" } }, { "name": "description", "description": "The ACL template description.", "required": true, "schema": { "type": "string", "description": "The ACL template description.", "example": "Test Template Description" } }, { "name": "inboundRules", "description": "An array of inbound rules.", "required": true, "schema": { "$ref": "#/components/schemas/InboundRules_2b9969ef" } }, { "name": "accountUcmId", "description": "A reseller updating an ACL template for a customer must pass the accountUcmId of the customer.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "A reseller updating an ACL template for a customer must pass the accountUcmId of the customer." } }, { "name": "projectId", "description": "Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.", "required": false, "schema": { "$ref": "#/components/schemas/ProjectId_cef15e62" } } ], "result": { "name": "network-edge_updateDeviceACLTemplateByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update ACL Template By Uuid", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_updateDeviceBackupByUuid", "summary": "Update Device Backup", "description": "Updates the name of a backup. Authorization checks are performed on users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Backup-and-Restore" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique ID of a backup", "required": true, "schema": { "type": "string", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b", "description": "Unique ID of a backup" } }, { "name": "name", "description": "The name of backup.", "required": true, "schema": { "type": "string", "description": "The name of backup.", "example": "My New Backup" } } ], "result": { "name": "network-edge_updateDeviceBackupByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update Device Backup", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_updateDeviceLinkGroupByUuid", "summary": "Update Device Link By Uuid", "description": "Call this API to update a device link. Authorization checks are performed on the users of this API.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Device-Link-Groups-and-Connections" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of a device link group.", "required": true, "schema": { "type": "string", "example": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567", "description": "Unique Id of a device link group." } }, { "name": "groupName", "description": "Group name.", "required": true, "schema": { "type": "string", "description": "Group name.", "example": "linkGroup" } }, { "name": "subnet", "description": "Subnet of the link group.", "required": true, "schema": { "type": "string", "description": "Subnet of the link group.", "example": "192.164.0.0/29" } }, { "name": "redundancyType", "description": "Whether the connection should be created through Fabric's primary or secondary port.", "required": false, "schema": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Whether the connection should be created through Fabric's primary or secondary port.", "example": "SECONDARY" } }, { "name": "linkDevices", "description": "An array of devices to link.", "required": false, "schema": { "$ref": "#/components/schemas/LinkDevices_21e67921" } }, { "name": "metroLinks", "description": "An array of links.", "required": false, "schema": { "$ref": "#/components/schemas/MetroLinks_7fdb4dcb" } } ], "result": { "name": "network-edge_updateDeviceLinkGroupByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update Device Link By Uuid", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_updateDeviceTemplatesbyUuid", "summary": "Update ACL of Virtual Device", "description": "Updates or removes the details of ACL templates associated with a device. You must provide the unique ID of an existing virtual device as a path parameter.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "ACL Template" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "virtualDeviceUuid", "description": "Unique Id of a virtual device.", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a virtual device." } }, { "name": "aclDetails", "description": "An array of ACLs.", "required": true, "schema": { "$ref": "#/components/schemas/AclDetails_f1a415d4" } }, { "name": "accountUcmId", "description": "A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer.", "required": false, "schema": { "type": "string", "example": "92D27009-EA33-4b60-B4FB-D3C4ED589649", "description": "A reseller updating a device ACL template for a customer can pass the accountUcmId of the customer." } } ], "result": { "name": "network-edge_updateDeviceTemplatesbyUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update ACL of Virtual Device", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_updateLicenseToken", "summary": "Update License Token/ID/Code", "description": "If you want to bring your own license (BYOL), you can use this API to post or update a license token after a virtual device is created.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of a virtual device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a virtual device" } }, { "name": "token", "required": false, "schema": { "type": "string", "example": "A1025025" } } ], "result": { "name": "network-edge_updateLicenseTokenResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "fileId": { "type": "string", "description": "The unique ID of the uploaded license file.", "example": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730" } }, "x-fastmcp-top-level-schema": "LicenseUploadResponse" } }, "x-mcp-annotations": { "title": "Update License Token/ID/Code", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "network-edge_updateVirtualDeviceByUuid", "summary": "Update Virtual Device By Uuid", "description": "Updates certain fields of a virtual device. You can only update the name, term length, status, and notification list of a virtual device.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Virtual-Device" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of a Virtual Device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a Virtual Device" } }, { "name": "core", "description": "Use this field to resize your device. When you call this API for device resizing, you cannot change other fields simultaneously.", "required": false, "schema": { "type": "integer", "description": "Use this field to resize your device. When you call this API for device resizing, you cannot change other fields simultaneously.", "example": 8 } }, { "name": "notifications", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "test1@example.com" } } }, { "name": "termLength", "description": "Term length in months.", "required": false, "schema": { "type": "string", "description": "Term length in months.", "example": "1, 12, 24, 36" } }, { "name": "termLengthEffectiveImmediate", "description": "By default, this field is true. Set it to false if you want to change the term length at the end of the current term. You cannot downgrade the term length before the end of your current term.", "required": false, "schema": { "type": "boolean", "description": "By default, this field is true. Set it to false if you want to change the term length at the end of the current term. You cannot downgrade the term length before the end of your current term.", "example": false } }, { "name": "virtualDeviceName", "description": "Virtual device name. This should be a minimum of 3 and a maximum of 50 characters.", "required": false, "schema": { "type": "string", "description": "Virtual device name. This should be a minimum of 3 and a maximum of 50 characters.", "example": "RCiscoSTROY" } }, { "name": "clusterName", "description": "Cluster name. This should be a minimum of 3 and a maximum of 50 characters.", "required": false, "schema": { "type": "string", "description": "Cluster name. This should be a minimum of 3 and a maximum of 50 characters.", "example": "myCluster0123" } }, { "name": "status", "description": "Status of the device. Use this field to update the license status of a device.", "required": false, "schema": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "description": "Status of the device. Use this field to update the license status of a device.", "example": "PROVISIONED" } }, { "name": "autoRenewalOptOut", "description": "By default, the autoRenewalOptOut field is false. Set it to true if you do not want to automatically renew your terms. Your device will move to a monthly cycle at the expiration of the current terms.", "required": false, "schema": { "type": "boolean", "description": "By default, the autoRenewalOptOut field is false. Set it to true if you do not want to automatically renew your terms. Your device will move to a monthly cycle at the expiration of the current terms.", "example": true } }, { "name": "vendorConfig", "description": "vendor config properties", "required": false, "schema": { "type": "object", "properties": { "disablePassword": { "type": "boolean", "description": "Disable device password.", "example": true } }, "description": "vendor config properties" } } ], "result": { "name": "network-edge_updateVirtualDeviceByUuidResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update Virtual Device By Uuid", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_uploadFile", "summary": "Upload File", "description": "Uploads a license or an initialization file. You can use this API to upload your bootstrap file generated from the Aviatrix controller portal. The response includes the unique ID of the uploaded file.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "file", "description": "A license or a cloud_init file.", "required": true, "schema": { "type": "string", "description": "A license or a cloud_init file.", "format": "binary", "example": "binary_content" } }, { "name": "metroCode", "description": "Two-letter metro code.", "required": true, "schema": { "type": "string", "description": "Two-letter metro code.", "example": "SV" } }, { "name": "deviceTypeCode", "description": "Device type code (e.g., C8000V)", "required": true, "schema": { "$ref": "#/components/schemas/DeviceTypeCode" } }, { "name": "processType", "description": "Whether you are uploading a license or a cloud_init file. LICENSE or CLOUD_INIT", "required": true, "schema": { "enum": [ "LICENSE", "CLOUD_INIT" ], "type": "string", "description": "Whether you are uploading a license or a cloud_init file. LICENSE or CLOUD_INIT", "example": "LICENSE" } }, { "name": "deviceManagementType", "description": "Device management type, whether SELF-CONFIGURED or EQUINIX-CONFIGURED", "required": false, "schema": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "description": "Device management type, whether SELF-CONFIGURED or EQUINIX-CONFIGURED", "example": "SELF-CONFIGURED" } }, { "name": "licenseType", "description": "Type of license (BYOL-Bring Your Own License)", "required": false, "schema": { "enum": [ "BYOL" ], "type": "string", "description": "Type of license (BYOL-Bring Your Own License)", "example": "BYOL" } } ], "result": { "name": "network-edge_uploadFileResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "fileUuid": { "type": "string", "description": "The unique ID of the uploaded file.", "example": "029a0bcd-0b2f-4bc5-b875-b506aa4b9738" } }, "x-fastmcp-top-level-schema": "FileUploadResponse" } }, "x-mcp-annotations": { "title": "Upload File", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_uploadLicense", "summary": "Upload License File", "description": "In case you want to bring your own license (BYOL), you can use this API to post a license file before creating a virtual device.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "metroCode", "description": "Two-letter metro code where the device will be created.", "required": true, "schema": { "type": "string", "example": "SV", "description": "Two-letter metro code where the device will be created." } }, { "name": "deviceTypeCode", "description": "Device type code (e.g., C8000V)", "required": true, "schema": { "$ref": "#/components/schemas/DeviceTypeCode" } }, { "name": "licenseType", "description": "Type of license (e.g., BYOL).", "required": true, "schema": { "enum": [ "BYOL" ], "type": "string", "example": "BYOL", "description": "Type of license (e.g., BYOL)." } }, { "name": "file", "description": "License file", "required": true, "schema": { "type": "string", "description": "License file", "format": "binary", "example": "binary_content" } }, { "name": "projectId", "description": "If projectId is different from default projectId, must pass a projectId parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "If projectId is different from default projectId, must pass a projectId parameter" } } ], "result": { "name": "network-edge_uploadLicenseResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "fileId": { "type": "string", "description": "The unique ID of the uploaded license file.", "example": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730" } }, "x-fastmcp-top-level-schema": "LicenseUploadResponse" } }, "x-mcp-annotations": { "title": "Upload License File", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "network-edge_uploadLicenseForDevice", "summary": "Upload License for a Virtual Device", "description": "In case you want to bring your own license and have already created a virtual device, use this API to post a license file. You can also use this API to renew a license that is about to expire.\n\nPart of the Equinix Network Edge API family (network-edge). Network Edge (NE) is a platform for deploying and running virtual network services and appliances such as routers, load balancers, and firewalls on generic hardware. This eliminates the need for dedicated hardware, upfront capital expenditure (CapEx), and colocation space.", "tags": [ { "name": "network-edge" }, { "name": "Availability-and-Metros" }, { "name": "network" }, { "name": "virtual-devices" } ], "paramStructure": "by-name", "params": [ { "name": "uuid", "description": "Unique Id of a virtual device", "required": true, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "Unique Id of a virtual device" } }, { "name": "file", "description": "License file", "required": true, "schema": { "type": "string", "description": "License file", "format": "binary", "example": "binary_content" } }, { "name": "projectId", "description": "If projectId is different from default projectId, must pass a projectId parameter", "required": false, "schema": { "type": "string", "example": "3da0a663-20d9-4b8f-8c5d-d5cf706840c8", "description": "If projectId is different from default projectId, must pass a projectId parameter" } } ], "result": { "name": "network-edge_uploadLicenseForDeviceResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "fileId": { "type": "string", "description": "The unique ID of the uploaded license file.", "example": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730" } }, "x-fastmcp-top-level-schema": "LicenseUploadResponse" } }, "x-mcp-annotations": { "title": "Upload License for a Virtual Device", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "notifications_get_ibx_Notification", "summary": "Get Ibx Notification", "description": "This API retrieves the details of a user's IBX notification by its identification (ID) number.\n\nPart of the Equinix Notification API family (notifications). Users can receive voice, SMS, or email notifications based on their notifications permissions in the Equinix Customer Portal. Once a user is granted notification permissions, they may view, subscribe, and select their notification preferences.", "tags": [ { "name": "notifications" }, { "name": "IbxNotification" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Ibx Notification Id of the record need to load.", "required": true, "schema": { "description": "Ibx Notification Id of the record need to load." } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "notifications_get_ibx_NotificationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "IbxNotification", "required": [ "id", "type", "startTimestamp", "ibxs", "status" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IbxNotificationSummary" }, { "$ref": "#/components/schemas/Notifications_get_ibx_NotificationResult" } ], "x-fastmcp-top-level-schema": "ibx-notification" } }, "x-mcp-annotations": { "title": "Get Ibx Notification", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "notifications_get_network_Notification", "summary": "Get Network Notification", "description": "This API retrieves the details of a user's network notification by its identification ID number.\n\nPart of the Equinix Notification API family (notifications). Users can receive voice, SMS, or email notifications based on their notifications permissions in the Equinix Customer Portal. Once a user is granted notification permissions, they may view, subscribe, and select their notification preferences.", "tags": [ { "name": "notifications" }, { "name": "NetworkNotification" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Network Notification Id of the record need to load.", "required": true, "schema": { "description": "Network Notification Id of the record need to load." } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "notifications_get_network_NotificationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "NetworkNotification", "required": [ "id", "type", "startTimestamp", "ibxs", "status" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/NetworkNotification" }, { "$ref": "#/components/schemas/Notifications_get_ibx_NotificationResult" } ], "x-fastmcp-top-level-schema": "network-notification" } }, "x-mcp-annotations": { "title": "Get Network Notification", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "notifications_search_ibx_notifications", "summary": "Ibx Notifications Search", "description": "Based on filtering criteria, this API returns a summary list of IBX notifications received by a user.\n\nPart of the Equinix Notification API family (notifications). Users can receive voice, SMS, or email notifications based on their notifications permissions in the Equinix Customer Portal. Once a user is granted notification permissions, they may view, subscribe, and select their notification preferences.", "tags": [ { "name": "notifications" }, { "name": "IbxNotification" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "The start index from which the list is created.", "required": false, "schema": { "description": "The start index from which the list is created." } }, { "name": "limit", "description": "Number of entries in response.", "required": false, "schema": { "description": "Number of entries in response." } }, { "name": "sorts", "description": "Notification sort to get the notification even in the response sorted in the particular order. for example, use '-id' to sort the notification by id in descending order. And 'id' for ascending order. For descending order, the field name should be prefixed with '-'. Default sort is -startDate.", "required": false, "schema": { "type": "array", "items": { "enum": [ "id", "status", "startDate", "endDate", "type", "-id", "-status", "-startDate", "-endDate", "-type" ], "type": "string" }, "default": "-startDate", "description": "Notification sort to get the notification even in the response sorted in the particular order. for example, use '-id' to sort the notification by id in descending order. And 'id' for ascending order. For descending order, the field name should be prefixed with '-'. Default sort is -startDate." } }, { "name": "filter", "description": "IBX Notification filter.", "required": false, "schema": { "type": "object", "properties": { "ibxs": { "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "List of IBX to be filtered.", "example": [ "SG2", "SV1" ] }, "types": { "type": "array", "items": { "enum": [ "IBX_MAINTENANCE", "IBX_INCIDENT", "IBX_ADVISORY", "IBX_SMARTVIEW" ], "type": "string" }, "description": "List of IBX Notification type to be filtered.", "example": [ "IBX_INCIDENT", "IBX_ADVISORY" ] }, "statuses": { "type": "array", "items": { "enum": [ "EXTENDED", "RESCHEDULED", "CANCELLED", "COMPLETED", "IN_PROGRESS", "RESOLVED", "UPDATED", "NEW" ], "type": "string" }, "description": "List of IBX Notification type to be filterd.", "example": [ "RESCHEDULED", "NEW" ] }, "dateRange": { "type": "object", "properties": { "fromDate": { "type": "string", "description": "Start date to filter the Notification event. Default will be the date 1 year prior to current date.", "format": "date-time", "example": "2018-01-28T03:46:36.720Z" }, "toDate": { "type": "string", "description": "End date to filter the Notification event.", "format": "date-time", "example": "2018-03-28T03:46:36.720Z" } }, "description": "IBX Notification date Range filter." } }, "description": "IBX Notification filter." } } ], "result": { "name": "notifications_search_ibx_notificationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "RemedyNotificationResponse", "type": "object", "allOf": [ { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IbxNotificationSummary" } }, "page": { "$ref": "#/components/schemas/PageInfo" }, "_links": { "$ref": "#/components/schemas/_links" } } } ], "x-fastmcp-top-level-schema": "ibx-notification-response" } }, "x-mcp-annotations": { "title": "Ibx Notifications Search", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "notifications_search_network_notifications", "summary": "Network Notifications Search", "description": "Based on filtering criteria, this API returns a summary list of network notifications received by a user.\n\nPart of the Equinix Notification API family (notifications). Users can receive voice, SMS, or email notifications based on their notifications permissions in the Equinix Customer Portal. Once a user is granted notification permissions, they may view, subscribe, and select their notification preferences.", "tags": [ { "name": "notifications" }, { "name": "NetworkNotification" } ], "paramStructure": "by-name", "params": [ { "name": "offset", "description": "The start index from which the list is created.", "required": false, "schema": { "description": "The start index from which the list is created." } }, { "name": "limit", "description": "Number of entries in response.", "required": false, "schema": { "description": "Number of entries in response." } }, { "name": "sorts", "description": "Notification sort to get the notification even in the response sorted in the particular order. for example, use '-id' to sort the notification by id in descending order. And 'id' for ascending order. For descending order, the field name should be prefixed with '-'. Default sort is -startDate. ", "required": false, "schema": { "type": "array", "items": { "enum": [ "id", "status", "startDate", "endDate", "type", "-id", "-status", "-startDate", "-endDate", "-type" ], "type": "string" }, "default": "-startDate", "description": "Notification sort to get the notification even in the response sorted in the particular order. for example, use '-id' to sort the notification by id in descending order. And 'id' for ascending order. For descending order, the field name should be prefixed with '-'. Default sort is -startDate. " } }, { "name": "filter", "description": "Network Notification filter.", "required": false, "schema": { "type": "object", "properties": { "ibxs": { "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "List of IBX to be filterd.", "example": [ "CH2", "SG1" ] }, "types": { "type": "array", "items": { "enum": [ "NETWORK_INCIDENT", "NETWORK_MAINTENANCE" ], "type": "string" }, "description": "List of Network Notification type to be filtered.", "example": [ "NETWORK_INCIDENT" ] }, "productTypes": { "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "List of network product type (Possible values: EXPEDITE, CLOUD_EXCHANGE, CLOUD_IX, CROSS_CONNECT, EQUINIX_CONNECT, ETHERNET_EXCHANGE, INTER_METRO_CONNECT, INTERNET_EXCHANGE, MANAGEMENT_ACCESS, METRO_CONNECT, MOBILITY_EXCHANGE, NETWORK_TIMING, VMMR_SDH, VOIP, BI_VLAN, BI_CLOUD). It may return UNKNOWN if no known product type is found.", "example": [ "CLOUD_EXCHANGE", "METRO_CONNECT" ] }, "statuses": { "type": "array", "items": { "enum": [ "EXTENDED", "RESCHEDULED", "CANCELLED", "COMPLETED", "IN_PROGRESS", "RESOLVED", "UPDATED", "NEW" ], "type": "string" }, "description": "List of Network Notification type to be filterd.", "example": [ "RESCHEDULED", "NEW" ] }, "dateRange": { "type": "object", "properties": { "fromDate": { "type": "string", "description": "Start date to filter the Notification event. Default will be the date 1 year prior to current date.", "format": "date-time", "example": "2018-01-28T03:46:36.720Z" }, "toDate": { "type": "string", "description": "End date to filter the Notification event.", "format": "date-time", "example": "2018-03-28T03:46:36.720Z" } }, "description": "Network Notification date Range filter." } }, "description": "Network Notification filter." } } ], "result": { "name": "notifications_search_network_notificationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "NetworkNotificationResponse", "type": "object", "allOf": [ { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkNotification" } }, "page": { "$ref": "#/components/schemas/PageInfo" }, "_links": { "$ref": "#/components/schemas/_links" } } } ], "x-fastmcp-top-level-schema": "network-notification-response" } }, "x-mcp-annotations": { "title": "Network Notifications Search", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "orderhistory_GET_retrieve_orders_locations", "summary": "Retrieve order permissible IBX locations", "description": "The API returns locations (IBXs and Cages) where the user's organization has a presence. The user may be able to view orders related to these locations, depending on their permissions.\n\nPart of the Equinix Retrieve Orders API family (orderhistory). Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.", "tags": [ { "name": "orderhistory" }, { "name": "Retrieve Orders" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } } ], "result": { "name": "orderhistory_GET_retrieve_orders_locationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "title": "Order-History-Location-Response", "type": "array", "items": { "title": "PermissibleLocation", "type": "object", "properties": { "ibx": { "title": "IBX Detail (Locations Endpoint)", "type": "object", "properties": { "code": { "type": "string", "description": "Ibx Code", "example": "AT1" }, "metro": { "type": "string", "description": "Metro code where ibx is located", "example": "AT" }, "region": { "type": "string", "description": "Region where ibx is located", "example": "AMER" }, "country": { "type": "string", "description": "Country where ibx is located", "example": "United States of America" }, "city": { "type": "string", "description": "City where ibx is located", "example": "Atlanta" }, "state": { "type": "string", "description": "State where ibx is located", "example": "GA" }, "address": { "type": "string", "description": "Address of the ibx", "example": "180 Peachtree Street NW, 2nd, 3rd and 6th Floors" }, "postalCode": { "type": "string", "description": "Postal code of ibx location", "example": "30303" } } }, "cages": { "type": "array", "items": { "type": "string", "description": "Cage in ibx", "example": "SV1:01:0101" } } } }, "x-fastmcp-top-level-schema": "order-history-location-response" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve order permissible IBX locations", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "orderhistory_POST_orders_history", "summary": "Search Orders History", "description": "Based on filtering criteria, this method returns a list of orders from the last 12 months for IBX locations where the user has permissions.\n\nPart of the Equinix Retrieve Orders API family (orderhistory). Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.", "tags": [ { "name": "orderhistory" }, { "name": "Retrieve Orders" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "filters", "required": false, "schema": { "title": "Retrieve Order filters", "type": "object", "properties": { "ibxs": { "type": "array", "items": { "type": "string", "example": "SV1" }, "description": "ibxs filter" }, "productTypes": { "type": "array", "items": { "title": "Product Types(Order Types) Enum", "enum": [ "SMART_HANDS", "TROUBLE", "SHIPMENT", "WORK_VISIT", "SECURITY_ACCESS", "CONFERENCE_ROOM", "TOUR_REQUESTS", "CROSS_CONNECT", "CLOUD_EXCHANGE_PORT", "INTERNET_EXCHANGE_PORT", "METRO_CONNECT", "POWER", "IBX_SMARTVIEW_SENSOR", "ACCESSORY", "CAGE", "CABINET", "IBX_SMART_VIEW" ], "type": "string", "example": "CROSS_CONNECT" }, "description": "Product(order type) filter" }, "orderStatus": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Header_Status_Enum" }, "description": "order status filter" }, "dateRange": { "enum": [ "PAST_7_DAYS", "PAST_14_DAYS", "PAST_30_DAYS", "PAST_3_MONTHS", "PAST_6_MONTHS", "PAST_YEAR" ], "type": "string", "description": "Date range filter", "example": "PAST_30_DAYS" }, "fromDate": { "type": "string", "description": "Date Format Should be mm/dd/yyyy.
Not applicable when dateRange is provided.", "format": "date", "example": "01/01/2019" }, "toDate": { "type": "string", "description": "Date Format Should be mm/dd/yyyy.
Not applicable when dateRange is provided", "format": "date", "example": "01/30/2019" } }, "example": { "orderStatus": [ "PENDING_QA", "IN_PROGRESS", "PARTIAL_SUBMISSION" ], "productTypes": [ "SMART_HANDS" ], "ibxs": [ "SV1" ], "fromDate": "05/01/2018", "toDate": "05/02/2018" } } }, { "name": "source", "description": "ORDER_NUMBER: Search by order number(1-123456789).
CUSTOMER_REFERENCE_NUMBER: Search by customer reference number which was entered as part place order.
TROUBLE_TICKET_NUMBER: Search by trouble ticket numnber(5-123456).
WORK_ACTIVITY_NUMBER: Search by work order activity number(3-123456). ", "required": false, "schema": { "type": "array", "items": { "enum": [ "ORDER_NUMBER", "PO_NUMBER", "CUSTOMER_REFERENCE_NUMBER", "CONTACT_LAST_NAME", "SR_NUMBER", "TROUBLE_TICKET_NUMBER", "WORK_ACTIVITY_NUMBER" ], "type": "string" }, "description": "ORDER_NUMBER: Search by order number(1-123456789).
CUSTOMER_REFERENCE_NUMBER: Search by customer reference number which was entered as part place order.
TROUBLE_TICKET_NUMBER: Search by trouble ticket numnber(5-123456).
WORK_ACTIVITY_NUMBER: Search by work order activity number(3-123456). " } }, { "name": "q", "description": "Query value to be queried against source values(Or operation against all sources).
Supports partial text search", "required": false, "schema": { "type": "string", "description": "Query value to be queried against source values(Or operation against all sources).
Supports partial text search", "example": "1-123456789" } }, { "name": "sorts", "required": false, "schema": { "type": "array", "items": { "title": "Sort", "type": "object", "properties": { "name": { "enum": [ "ORDERING_CONTACT", "ACCOUNT_NUMBER", "CREATED_ON" ], "type": "string", "description": "ORDERING_CONTACT sort is applicable on ordering contact last name." }, "direction": { "enum": [ "ASC", "DESC" ], "type": "string" } } } } }, { "name": "page", "required": false, "schema": { "title": "Page Request", "type": "object", "properties": { "number": { "type": "integer", "description": "Page number indexed from 0.", "default": 0, "example": 0 }, "size": { "maximum": 200.0, "type": "integer", "description": "Page Size.", "default": 10, "example": 25 } } } } ], "result": { "name": "orderhistory_POST_orders_historyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Order History Response", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "Order Header", "required": [ "submittedDate" ], "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order number", "example": "1-12345678" }, "type": { "type": "array", "items": { "type": "string", "example": "Cross Connect, Smart Hands" }, "description": "List Of Proudcts Ordered in the Order." }, "orderStatus": { "$ref": "#/components/schemas/Order_Header_Status_Enum" }, "createdAt": { "type": "string", "description": "Order Created DateTime in ISO Date Format", "example": "2019-07-02T22:01:50Z" }, "account": { "title": "Account", "required": [ "number", "name" ], "type": "object", "properties": { "number": { "type": "string", "description": "Account Number", "example": 136008 }, "name": { "type": "string", "description": "Name of Account", "example": "Service Corporation" } } }, "orderingContact": { "title": "Ordering Contact", "type": "object", "properties": { "name": { "type": "string", "description": "Ordering Contact name", "example": "John Doe" }, "email": { "type": "string", "description": "Ordering Contact email", "example": "johnDoe@test.com" }, "phone": { "type": "string", "description": "Ordering Contact phone", "example": "+1 408 123 1234" } } }, "notificationContact": { "title": "Notification Contact", "type": "object", "properties": { "name": { "type": "string", "description": "Notification Contact name", "example": "John Doe" }, "email": { "type": "string", "description": "Notification Contact email", "example": "johnDoe@test.com" }, "phone": { "type": "string", "description": "Notification Contact phone", "example": "+1 408 123 1234" } } }, "ibx": { "type": "array", "items": { "type": "string", "example": "SV1" }, "description": "List of ibxs for the order lines." }, "customerReferenceNumbers": { "type": "array", "items": { "type": "string", "example": "cust-100" }, "description": "List of customer reference numbers for the order lines." }, "links": { "type": "array", "items": { "title": "Link", "type": "object", "properties": { "rel": { "enum": [ "self", "prev", "next", "orderFullDetails" ], "type": "string" }, "href": { "type": "string", "example": "https://api.equinix.com/v1/retrieve-orders" } } } } } } }, "links": { "type": "array", "items": { "title": "Link", "type": "object", "properties": { "rel": { "enum": [ "self", "prev", "next", "orderFullDetails" ], "type": "string" }, "href": { "type": "string", "example": "https://api.equinix.com/v1/retrieve-orders" } } } }, "page": { "title": "Orders Response Page Details", "type": "object", "properties": { "size": { "type": "integer", "description": "Page Size", "example": "25" }, "totalElements": { "type": "number", "description": "Total number of records", "example": "160" }, "totalPages": { "type": "integer", "description": "Total number of pages", "example": "7" }, "number": { "type": "integer", "description": "Current page number", "example": "0" } } } }, "x-fastmcp-top-level-schema": "order-history-response" } }, "x-mcp-annotations": { "title": "Search Orders History", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "orders_Add_notes_to_an_order", "summary": "Add notes to an order", "description": "This method adds notes to an order by its ID for a user with permission to view this request.\n\nPart of the Equinix Orders API family (orders). Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.", "tags": [ { "name": "orders" }, { "name": "Orders" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the order", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "example": "{orderId}", "description": "Identifier of the order" } }, { "name": "referenceId", "description": "Unique reference ID associated with notes.", "required": false, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Unique reference ID associated with notes.", "example": "{orderId}" } }, { "name": "text", "description": "The text of the note", "required": false, "schema": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "The text of the note", "example": "The text of the note" } }, { "name": "attachments", "description": "File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_32698a8e" } } ], "result": { "name": "orders_Add_notes_to_an_orderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Add notes to an order", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "orders_Cancel_an_order", "summary": "Cancel an order", "description": "This method cancels an order by its ID for a user with permission to view this request.\n\nPart of the Equinix Orders API family (orders). Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.", "tags": [ { "name": "orders" }, { "name": "Orders" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the order", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Identifier of the order" } }, { "name": "reason", "description": "Reason for cancellation", "required": true, "schema": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "Reason for cancellation" } }, { "name": "attachments", "description": "File(s) attached", "required": false, "schema": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_f75b83cc" }, "description": "File(s) attached" } }, { "name": "lineIds", "description": "Refers to the `lineId` of product/service.", "required": false, "schema": { "maxItems": 1, "minItems": 0, "type": "array", "items": { "type": "string" }, "description": "Refers to the `lineId` of product/service.", "example": [ "1-D89731S" ] } } ], "result": { "name": "orders_Cancel_an_orderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Cancel an order", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "orders_GET_Order_details", "summary": "Retrieve an order", "description": "This method retrieves an order by its ID for a user with permission to view this request.\n\nPart of the Equinix Orders API family (orders). Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.", "tags": [ { "name": "orders" }, { "name": "Orders" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the Order", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Identifier of the Order" } }, { "name": "ibxs", "description": "List of IBXs to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "example": "SG1", "description": "List of IBXs to be filtered" } } ], "result": { "name": "orders_GET_Order_detailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "allOf": [ { "type": "object", "properties": { "orderId": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Unique identifier of the order." }, "accountName": { "type": "string", "description": "Customer account name" }, "accountNumber": { "type": "string", "description": "Customer account number" }, "quoteRequestType": { "enum": [ "NEW", "AMENDMENT", "PAPERWORK", "REPLACEMENT_RENEWAL", "TERMINATION", "MIGRATION" ], "type": "string", "description": "The request type of the quote" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "registeredUser": { "type": "string", "description": "Username of a registered user.", "example": "john_doe" }, "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "type": { "enum": [ "ORDERING", "NOTIFICATION", "TECHNICAL", "RESELLER" ], "type": "string", "description": "Communications type" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Contact's availability to receive calls.", "default": "ANYTIME" }, "timezone": { "enum": [ "Atlantic/Canary", "Europe/Dublin", "Europe/London", "Europe/Lisbon", "Africa/Algiers", "Europe/Berlin", "Europe/Amsterdam", "Europe/Copenhagen", "Europe/Madrid", "Europe/Paris", "Europe/Stockholm", "Europe/Zurich", "Europe/Warsaw", "Africa/Cairo", "Africa/Johannesburg", "Africa/Lagos", "Europe/Sofia", "Africa/Nairobi", "Asia/Jerusalem", "Europe/Istanbul", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Kabul", "Asia/Tehran", "Asia/Karachi", "Indian/Maldives", "Asia/Kolkata", "Asia/Kathmandu", "Asia/Omsk", "Asia/Rangoon", "Asia/Jakarta", "Asia/Ho_Chi_Minh", "Asia/Brunei", "Asia/Hong_Kong", "Asia/Kuala_Lumpur", "Asia/Manila", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Australia/Perth", "Asia/Seoul", "Asia/Tokyo", "Australia/Darwin", "Australia/Brisbane", "Pacific/Guam", "Australia/Adelaide", "Australia/Sydney", "Pacific/Auckland", "Pacific/Chatham", "Indian/Christmas", "America/Scoresbysund", "Atlantic/South_Georgia", "America/Sao_Paulo", "America/Detroit", "America/New_York", "America/Puerto_Rico", "America/Toronto", "America/Bogota", "America/Chicago", "America/Winnipeg", "America/Denver", "America/Edmonton", "America/Mexico_City", "America/Los_Angeles", "America/Vancouver", "America/Phoenix", "America/Anchorage", "America/Halifax", "America/Lima", "America/Monterrey", "Pacific/Gambier", "Pacific/Marquesas", "Pacific/Honolulu", "Pacific/Fiji", "Asia/Muscat", "America/Argentina/Buenos_Aires", "America/Caracas", "Etc/GMT+12", "UTC", "GMT", "America/Santiago", "America/St_Johns", "Asia/Almaty", "Asia/Bangkok", "Asia/Calcutta", "Asia/Magadan", "Asia/Yekaterinburg", "Australia/Eucla", "Australia/Lord_Howe", "Europe/Bratislava", "Europe/Brussels", "Europe/Prague", "Europe/Rome", "Europe/Helsinki", "Pacific/Kiritimati", "Pacific/Midway", "Pacific/Tongatapu", "Australia/Melbourne", "Australia/NSW", "Australia/Queensland", "Australia/South", "Australia/Victoria", "Australia/West", "Australia/Canberra" ], "type": "string", "description": "Contact's timezone", "example": "America/Los_Angeles" }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "PHONE", "EMAIL", "MOBILE" ], "type": "string", "description": "Communications Type ", "example": "PHONE" }, "value": { "type": "string", "description": "Value of contact details `type`", "example": "+1-4601231122" } }, "description": "Contact information." }, "description": "Reference of the related party, could be a party reference or a party role reference" } }, "description": "Contact information." }, "description": "The related party associated with the ticket." }, "status": { "enum": [ "RECEIVED", "IN_PROGRESS", "ON_HOLD", "CLOSED", "CANCELLED" ], "type": "string", "description": "The current status of the order or service" }, "createdDateTime": { "type": "string", "description": "The order created date and time in UTC timezone.", "format": "date-time" }, "updatedDateTime": { "type": "string", "description": "The order updated date and time in UTC timezone.", "format": "date-time" }, "closedDateTime": { "type": "string", "description": "The order closed date and time in UTC timezone.", "format": "date-time" }, "estimatedCompletionDateTime": { "type": "string", "description": "The estimated completion date and time in UTC timezone", "format": "date-time" }, "currencyCode": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "type": "string", "description": "ISO-4217 currency code" }, "channel": { "enum": [ "API", "PORTAL", "MOBILE", "OFFLINE" ], "type": "string", "description": "Type of channel used to place the order" }, "subChannel": { "enum": [ "ECP", "ECX", "IX", "NE", "EMG", "QUOTE" ], "type": "string", "description": "Type of sub-channel used to place the order" }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the note" }, "referenceId": { "type": "string", "description": "Unique identifier for referencing notes." }, "createdDateTime": { "type": "string", "description": "Date and time of the note creation in UTC timezone", "format": "date-time" }, "text": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "The content of the note", "example": "Please refer to the attachment for patch panel image" }, "author": { "minLength": 5, "type": "string", "description": "Author of the notes", "example": "johndoe@acme.com" }, "type": { "enum": [ "CUSTOMER_QUERY", "CUSTOMER_NOTES", "TECHNICIAN_QUERY", "TECHNICIAN_NOTES" ], "type": "string", "description": "Type of notes", "example": "CUSTOMER_NOTES" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_f75b83cc" }, "description": "File(s) attached to the orders. To learn about including attachments in your request, refer to Attachments API." } }, "description": "Extra information about a given entity" }, "description": "The notes that are associated to the orders." }, "additionalInfo": { "$ref": "#/components/schemas/Additional_product_details" }, "customerReferenceId": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Customer Reference Number / External Reference Number" }, "cancellable": { "type": "boolean", "description": "When `true`, order can be cancelled.", "default": false }, "modifiable": { "type": "boolean", "description": "When `true`, order can be modified.", "default": false } }, "description": "Orders Base is the properties or attributes which common for every order details" }, { "type": "object", "properties": { "details": { "type": "array", "items": { "type": "object", "properties": { "lineId": { "type": "string", "description": "Unique identifier associated with line item. ", "example": "1-NEYSNX123" }, "parentlineId": { "type": "string", "description": "Unique identifier associated with `lineId`to denote hierarchy of the product. When this field is null, item considered to be at root level.", "example": "1-NEYSNX124" }, "rootlineId": { "type": "string", "description": "Unique identifier to specify root item. Useful when product order hierarchy exceeds 2.", "example": "1-NEYSNX120" }, "status": { "type": "string", "description": "The current status of the order or service" }, "description": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "Description of the orders." }, "billingStartDateTime": { "type": "string", "description": "Billing commencement date and time in UTC timezone", "format": "date-time" }, "estimatedCompletionDateTime": { "type": "string", "description": "The estimated completion date and time in UTC timezone", "format": "date-time" }, "unitPricing": { "type": "array", "items": { "$ref": "#/components/schemas/UnitPricingItem" }, "description": "Unit Pricing details" }, "totalPricing": { "type": "array", "items": { "$ref": "#/components/schemas/UnitPricingItem" }, "description": "Total Pricing details" }, "productType": { "enum": [ "CROSS_CONNECT", "SMART_HANDS", "WORK_VISIT", "SECURITY_ACCESS", "CONFERENCE_ROOM", "TROUBLE_TICKET", "SHIPMENTS", "NETWORK_PORTS", "DEINSTALL_CROSS_CONNECT", "OTHER" ], "type": "string", "description": "Type of product" }, "productCode": { "type": "string", "description": "Product code associated with a particular product", "example": "CC00001" }, "productName": { "type": "string", "description": "Product name", "example": "Cage with KVA Power" }, "ibx": { "type": "string", "description": "Location code of Equinix datacenter" }, "cage": { "type": "string", "description": "Cage ID" }, "cabinets": { "type": "array", "items": { "type": "string" }, "description": "One or more cabinets ID" }, "requestType": { "enum": [ "ADD", "DELETE", "NO_CHANGE", "UPDATE" ], "type": "string", "description": "Type of order request. ie `requestType` can be of `ADD` if you are adding new services/product.", "example": "ADD" }, "attachments": { "$ref": "#/components/schemas/Attachments_32698a8e" }, "additionalInfo": { "$ref": "#/components/schemas/Additional_product_details" }, "purchaseOrder": { "type": "object", "properties": { "type": { "enum": [ "EXEMPTED", "NEW", "EXISTING" ], "type": "string", "description": "Type of the purchase order" }, "number": { "type": "string", "description": "Purchase order number" }, "closingDate": { "type": "string", "description": "Closing date of purchase order.", "format": "date", "example": "2020-08-25T00:00:00.000Z" } }, "description": "Purchase Order" }, "cancellable": { "type": "boolean", "description": "When `true`, order can be cancelled", "default": false }, "modifiable": { "type": "boolean", "description": "When `true`, order can be modified" } }, "description": "Orders Line contains information appplicable for all the orders type i.e smart hands, work visit and cross connect" } } } } ], "description": "An order could be request, service or ticket to performs specified activity on an colo businesss", "x-fastmcp-top-level-schema": "Orders" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve an order", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "orders_Reply_to_an_order_negotiation", "summary": "Reply to an order negotiation", "description": "This method approves or rejects an order negotiation for a user with permission to view this request.\n\nPart of the Equinix Orders API family (orders). Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.", "tags": [ { "name": "orders" }, { "name": "Orders" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the order", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "example": "{orderId}", "description": "Identifier of the order" } }, { "name": "referenceId", "description": "Unique identifier to reference specific activity or order line id. ", "required": false, "schema": { "type": "string", "description": "Unique identifier to reference specific activity or order line id. ", "example": "4-9091830" } }, { "name": "action", "description": "Type of actions to be carried out with negotiation. Use `APPROVE` to accept order with new proposed date, `APPROVE_NON_EXPEDITE` to accept order without expedite and `CANCEL` to cancel order", "required": false, "schema": { "enum": [ "APPROVE", "APPROVE_NON_EXPEDITE", "CANCEL" ], "type": "string", "description": "Type of actions to be carried out with negotiation. Use `APPROVE` to accept order with new proposed date, `APPROVE_NON_EXPEDITE` to accept order without expedite and `CANCEL` to cancel order" } }, { "name": "reason", "description": "Reason for cancelling the negotiation", "required": false, "schema": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "Reason for cancelling the negotiation", "example": "Cancelling the new time" } } ], "result": { "name": "orders_Reply_to_an_order_negotiationResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Reply to an order negotiation", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "orders_Retrieve_order_negotiations", "summary": "Retrieve order negotiations", "description": "This method retrieves order negotiations by its ID for a user with permission to view this request.\n\nPart of the Equinix Orders API family (orders). Based on a user's permission, a user may be able to view their own orders or also the orders from all of the users in their organization. These orders can be filtered by product type, order status, location, or date range. Only orders from the past 12 months will be returned.", "tags": [ { "name": "orders" }, { "name": "Orders" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the order", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "example": "{orderId}", "description": "Identifier of the order" } } ], "result": { "name": "orders_Retrieve_order_negotiationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "title": "Messages", "type": "array", "items": { "title": "Negotiations messages", "type": "object", "properties": { "referenceId": { "type": "string", "description": "Reference id / internal id for customer to identify the actionable order line" }, "orderRequestedDateTime": { "type": "string", "description": "Customer requested order date and time at point of order.", "format": "date-time" }, "proposedDateTime": { "type": "string", "description": "Alternative / revised date and time proposed by Equinix for fulfilling the order request.", "format": "date-time" }, "expirationDateTime": { "type": "string", "description": "Validity date and time of the negotiation. Negotiations request after this date will no longer be valid.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "Negotiations message created date and time by operations team", "format": "date-time" }, "expedited": { "type": "boolean", "description": "When `true,` requested order is an expedite order" }, "message": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "Negotiations message" } }, "description": "Negotiations message with alternative date and time" }, "x-fastmcp-top-level-schema": "NegotiationsMessages" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve order negotiations", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "quotes_Retrieve_a_quote", "summary": "Retrieve a quote", "description": "This method retrieves a specific quote by its ID for a user with appropriate viewing permission.\n\nPart of the Equinix Quote API family (quotes). Quote API allow users to retrieve detailed information about their Equinix quote. Users can use this API to get line level product and service pricing. In additional, users can also obtain important information such as quote expiry date and terms of use.", "tags": [ { "name": "quotes" }, { "name": "Quote" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "quoteId", "description": "Identifier of the quote", "required": true, "schema": { "maximum": 100.0, "minimum": 1.0, "type": "string", "description": "Identifier of the quote" } }, { "name": "ibxs", "description": "List of IBXs to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "example": "SG1", "description": "List of IBXs to be filtered" } } ], "result": { "name": "quotes_Retrieve_a_quoteResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "allOf": [ { "type": "object", "properties": { "quoteId": { "type": "string", "description": "Equinix quote ID. ", "example": "1-1234567891011" }, "accountName": { "type": "string", "description": "Customer account name", "example": "AAA Corporation Ltd" }, "accountNumber": { "type": "string", "description": "Customer account number", "example": "123456" }, "quoteRequestType": { "enum": [ "NEW", "AMENDMENT", "PAPERWORK", "REPLACEMENT_RENEWAL", "TERMINATION", "MIGRATION" ], "type": "string", "description": "The request type of the quote" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "registeredUser": { "type": "string", "description": "Username of a registered user.", "example": "john_doe" }, "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "type": { "enum": [ "QUOTATION", "SUPPLIER" ], "type": "string", "description": "contact type" }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "PHONE", "EMAIL", "MOBILE" ], "type": "string", "description": "Communications Type ", "example": "PHONE" }, "value": { "type": "string", "description": "Unique identifier of a related party (eg, Phone Number, email address)", "example": "+1-4601231122" } }, "description": "Contact information." }, "description": "Reference of the related party, could be a party reference or a party role reference" } }, "description": "Contact information." }, "description": "The related party(ies) that are associated to the quote." }, "status": { "enum": [ "SUBMITTED", "APPROVED" ], "type": "string", "description": "The current status of the quote" }, "createdDateTime": { "type": "string", "description": "The quote created date and time in UTC timezone.", "format": "date-time", "example": "2020-11-19T06:51:10.000Z" }, "updatedDateTime": { "type": "string", "description": "The quote updated date and time in UTC timezone.", "format": "date-time", "example": "2020-11-20T06:51:10.000Z" }, "expirationDateTime": { "type": "string", "description": "The quote expiration date and time in UTC timezone. Quote will be invalid when `expirationDateTime` has passed.", "format": "date-time", "example": "2020-12-31T06:51:10.000Z" }, "channel": { "enum": [ "PORTAL", "OFFLINE" ], "type": "string", "description": "The channel which quote was being requested." }, "subChannel": { "enum": [ "QUOTE" ], "type": "string", "description": "The sub-channel which quote was being requested." }, "customerReferenceId": { "type": "string", "description": "Customer Reference Number / External Reference Number", "example": "048837d6-4cd8-401f-ba41-a4ac015c3f3e" }, "agreementNumber": { "type": "string", "description": "Quote agreement number" }, "currencyCode": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "type": "string", "description": "The quote currency code in ISO-4217 format" }, "termsOfUse": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "integer", "description": "Denotes the value of period" }, "period": { "enum": [ "MONTHS", "DAYS" ], "type": "string", "description": "Denotes the period type" }, "type": { "enum": [ "INITIAL_TERM", "RENEWAL_TERM", "NON_RENEWAL_NOTICE" ], "type": "string", "description": "Type of quote terms" } } }, "description": "Terms and conditions of quote such as initial term, renewal period and non-renewal notice. " }, "totalPricing": { "type": "array", "items": { "$ref": "#/components/schemas/Pricing_Details" }, "description": "Pricing details of grand total price" }, "versionNumber": { "type": "string", "description": "Version number will be updated when quote is revised" } } }, { "properties": { "details": { "type": "array", "items": { "type": "object", "properties": { "lineId": { "type": "string", "description": "Unique identifier associated with line item.", "example": "1-NEYSNX123" }, "parentLineId": { "type": "string", "description": "Unique identifier associated with `lineId` to denote hierarchy of the product. When this field is null, item is at root level.", "example": "1-NEYSNX124" }, "rootLineId": { "type": "string", "description": "Unique identifier to specify root item. Useful when product order hierarchy exceeds 2.", "example": "1-NEYSNX120" }, "ibx": { "type": "string", "description": "Location code of Equinix datacenter", "example": "AM1" }, "cage": { "type": "string", "description": "Cage ID", "example": "DC2:01:001030" }, "productDescription": { "type": "string", "description": "Description of the product. ", "example": "Smart Hands Support Plan" }, "productType": { "enum": [ "CROSS_CONNECT", "SMART_HANDS", "WORK_VISIT", "SECURITY_ACCESS", "CONFERENCE_ROOM", "TROUBLE_TICKET", "SHIPMENTS", "NETWORK_PORTS", "DEINSTALL_CROSS_CONNECT", "CLOUD_EXCHANGE_PORTS", "OTHER" ], "type": "string", "description": "Product type" }, "productCode": { "type": "string", "description": "Equinix Product catalog code.", "example": "PS00002.PROD" }, "productName": { "type": "string", "description": "Product name", "example": "Smart Hands Support Plan" }, "assetizable": { "type": "boolean", "description": "When this value is `true`, line item is assetizable." }, "lineItemModified": { "type": "boolean", "description": "When this value is `true`, it means there are changes to POE." }, "quantity": { "type": "number", "description": "The total amount of quantity bought. To be used with `unitOfMeasure` to derive value", "example": 20 }, "unitOfMeasure": { "enum": [ "CAB", "EACH", "MBP", "KVA", "GB", "HRS", "SFT", "LF", "KWH" ], "type": "string", "description": "Metric of `quantity`", "example": "HRS" }, "unitPricing": { "$ref": "#/components/schemas/UnitPricing" }, "totalPricing": { "$ref": "#/components/schemas/UnitPricing" }, "requestType": { "enum": [ "ADD", "DELETE", "UPDATE", "NO_CHANGE" ], "type": "string", "description": "Type of order request. For example, requestType can be of ADD if you are adding new services/product." }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "description": "This section is reserved to display product specific information" } } }, "description": "Quote details of line items" } } } ], "x-fastmcp-top-level-schema": "quote_response" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve a quote", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_deleteReports", "summary": "Delete your generated reports", "description": "Use this API to delete specific generated reports of an authenticated user by the generated reports' report IDs.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "reportIds", "description": "Comma separated report ids to be deleted.", "required": true, "schema": { "maxItems": 20, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Comma separated report ids to be deleted." } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_deleteReportsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadableReport" } } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Delete your generated reports", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_deleteScheduledReports", "summary": "Delete your scheduled reports", "description": "Use this API to delete specific recurring reports of an authenticated user by the recurring reports' scheduled IDs.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "scheduledIds", "description": "Comma separated scheduled ids to be deleted.", "required": true, "schema": { "maxItems": 20, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Comma separated scheduled ids to be deleted." } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_deleteScheduledReportsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Status", "required": [ "status" ], "type": "object", "properties": { "status": { "type": "boolean", "description": "staus of the operation", "default": true } }, "x-fastmcp-top-level-schema": "status" } }, "x-mcp-annotations": { "title": "Delete your scheduled reports", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_downloadReport", "summary": "Download a generated report", "description": "This method downloads a specific generated report that was originally triggered by the authenticated user.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "reportId", "description": "Unique identifier of generated report", "required": true, "schema": { "description": "Unique identifier of generated report" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_downloadReportResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "string", "format": "binary" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Download a generated report", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_downloadReports", "summary": "Download list of generated reports", "description": "Use this method to download a list of generated reports triggered by the authenticated user.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "reportIds", "description": "Comma separated report ids to be deleted.", "required": true, "schema": { "maxItems": 20, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Comma separated report ids to be deleted." } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_downloadReportsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "string", "format": "binary" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Download list of generated reports", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_generateReport", "summary": "Generate new report from schedule", "description": "Use this API to generate a new report from an existing scheduled report of the authenticated user, as identified by its scheduled ID.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "scheduledId", "description": "Scheduled Id to generate a new report", "required": true, "schema": { "description": "Scheduled Id to generate a new report" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_generateReportResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Report_86ef4952" } }, "x-mcp-annotations": { "title": "Generate new report from schedule", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "reports_getReportById", "summary": "Get details of generated report", "description": "Use this API to get the details of a report triggered for generated by the authenticated user.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "reportId", "description": "Unique identifier of generated report", "required": true, "schema": { "description": "Unique identifier of generated report" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_getReportByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Report_86ef4952" } }, "x-mcp-annotations": { "title": "Get details of generated report", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_getReportDefinition", "summary": "Get report definition by name", "description": "Use this API to return the parameter configurations and applicable values for a specific report type supported by Equinix.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "reportName", "description": "Unique report name of the definition", "required": true, "schema": { "description": "Unique report name of the definition" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_getReportDefinitionResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "ReportRequest", "required": [ "name", "parameters", "scheduleType", "period" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Report Name" }, "parameters": { "$ref": "#/components/schemas/Parameters_de963ee8" }, "scheduleType": { "title": "ScheduleType", "enum": [ "ONE_TIME", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Scheduling strategy for the report to be generated." }, "period": { "title": "Period", "enum": [ "1_DAY", "7_DAYS", "14_DAYS", "30_DAYS", "90_DAYS", "180_DAYS", "1_YEAR", "CUSTOM", "NONE" ], "type": "string", "description": "Date range which the report should be generated" }, "control": { "enum": [ "ALLOW", "DENY" ], "type": "string", "description": "Indicates whether user is entitled to use this report type." }, "categories": { "uniqueItems": true, "type": "array", "items": { "enum": [ "SECURITY", "SITE_AND_ENVIRONMENT", "ASSET", "POWER", "FINANCE" ], "type": "string" }, "description": "The list of categories this definition belongs to" } }, "example": { "name": "eu exercitation", "parameters": [ { "name": "id sunt", "value": "tempor consequat minim", "type": "INT" }, { "name": "eu consequat minim commodo", "value": "Duis ex laboris", "type": "LONG" }, { "name": "nostrud nulla in minim", "value": "est laborum magna ea", "type": "STRING" }, { "name": "ut ullamco pariatur ex", "value": "laboris Duis commodo culpa", "type": "LONG" } ], "scheduleType": "MONTHLY", "period": "30_DAYS" }, "x-fastmcp-top-level-schema": "reportRequest" } }, "x-mcp-annotations": { "title": "Get report definition by name", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_getReportDefinitions", "summary": "Get all reports definitions", "description": "This API returns all the parameter configurations and applicable values for all the report types supported by Equinix.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_getReportDefinitionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "title": "ReportRequest", "required": [ "name", "parameters", "scheduleType", "period" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Report Name" }, "parameters": { "$ref": "#/components/schemas/Parameters_de963ee8" }, "scheduleType": { "title": "ScheduleType", "enum": [ "ONE_TIME", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Scheduling strategy for the report to be generated." }, "period": { "title": "Period", "enum": [ "1_DAY", "7_DAYS", "14_DAYS", "30_DAYS", "90_DAYS", "180_DAYS", "1_YEAR", "CUSTOM", "NONE" ], "type": "string", "description": "Date range which the report should be generated" }, "control": { "enum": [ "ALLOW", "DENY" ], "type": "string", "description": "Indicates whether user is entitled to use this report type." }, "categories": { "uniqueItems": true, "type": "array", "items": { "enum": [ "SECURITY", "SITE_AND_ENVIRONMENT", "ASSET", "POWER", "FINANCE" ], "type": "string" }, "description": "The list of categories this definition belongs to" } }, "example": { "name": "eu exercitation", "parameters": [ { "name": "id sunt", "value": "tempor consequat minim", "type": "INT" }, { "name": "eu consequat minim commodo", "value": "Duis ex laboris", "type": "LONG" }, { "name": "nostrud nulla in minim", "value": "est laborum magna ea", "type": "STRING" }, { "name": "ut ullamco pariatur ex", "value": "laboris Duis commodo culpa", "type": "LONG" } ], "scheduleType": "MONTHLY", "period": "30_DAYS" } } } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Get all reports definitions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_getReports", "summary": "Get your generated reports", "description": "Use this method to get a list of reports triggered for generation by the authenticated user.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } }, { "name": "offset", "description": "The start index from which the list is created.", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "description": "The start index from which the list is created." } }, { "name": "limit", "description": "Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response", "required": false, "schema": { "maximum": 100.0, "minimum": 0.0, "type": "integer", "default": 10, "description": "Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response" } }, { "name": "duration", "description": "Number of days since should reports be searched", "required": false, "schema": { "maximum": 365.0, "minimum": 1.0, "type": "integer", "default": 7, "description": "Number of days since should reports be searched" } }, { "name": "sorts", "description": "Use sort to get the reports in the response sorted in the particular order. for example, use '-GENERATED_DATE' to sort the reports by generated date in descending order. And ‘GENERATED_DATE’ for ascending order. For descending order, the field name should be prefixed with '-'", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "REPORT_NAME", "-REPORT_NAME", "GENERATED_DATE", "-GENERATED_DATE", "REQUESTED_DATE", "-REQUESTED_DATE" ], "type": "string" }, "default": "-GENERATED_DATE", "description": "Use sort to get the reports in the response sorted in the particular order. for example, use '-GENERATED_DATE' to sort the reports by generated date in descending order. And ‘GENERATED_DATE’ for ascending order. For descending order, the field name should be prefixed with '-'" } }, { "name": "statuses", "description": "List of statuses of reports to be searched.", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "IN_PROGRESS", "SUCCESS", "ERROR" ], "type": "string" }, "default": [ "IN_PROGRESS", "SUCCESS", "ERROR" ], "description": "List of statuses of reports to be searched." } } ], "result": { "name": "reports_getReportsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "SearchReportResponse", "required": [ "data", "_links" ], "type": "object", "properties": { "data": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/DownloadableReport" }, "description": "List of records" }, "page": { "$ref": "#/components/schemas/Page" }, "_links": { "$ref": "#/components/schemas/Links_4fb063ac" } }, "example": { "data": [ { "reportId": "0c1ba2a7-053c-4974-b4c1-ad22f5765f03", "status": "ERROR" }, { "reportId": "c9f8029d-62b0-4a42-b1c9-cb924515f80e", "status": "IN_PROGRESS", "scheduledId": "69db9183-e9cc-4cd8-aaf8-d0aec8e64d07", "createdBy": "in est officia", "fileSize": 5997663, "requestedDate": "2389-02-21T23:38:54.744Z" }, { "reportId": "0d63a95b-3649-49f3-9658-0cf637bf2e54", "status": "IN_PROGRESS", "requestedDate": "2386-09-09T17:54:06.104Z", "fileType": "XLS", "createdBy": "ullamco labor", "scheduledId": "b84a6bae-3b39-4aef-b6ea-dd3d30b78ef6" }, { "reportId": "3190b044-8215-4fc7-a2cf-720bf7df7642", "status": "INACTIVE", "fileSize": 40635347, "createdBy": "eu minim", "reportName": "laborum sint aliqua occ", "fileType": "CSV" } ], "page": { "total": 57630205, "limit": 82388200, "offset": 86416613, "sorts": [ "esse", "cupidatat Ut fugiat ut ad" ] }, "_links": { "self": { "href": "esse in Excepteur do" }, "next": { "href": "sunt sit" } } }, "x-fastmcp-top-level-schema": "search-report-response" } }, "x-mcp-annotations": { "title": "Get your generated reports", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_getScheduledReport", "summary": "Get details of scheduled report", "description": "Use this API to get the report details of a specific recurring scheduled report requested by the authenticated user.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "scheduledId", "description": "Scheduled Id for the report entry", "required": true, "schema": { "description": "Scheduled Id for the report entry" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } } ], "result": { "name": "reports_getScheduledReportResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/ScheduledReport" } }, "x-mcp-annotations": { "title": "Get details of scheduled report", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_getScheduledReports", "summary": "Get your Scheduled Reports", "description": "Use this method to get a list of reports that the authenticated user has scheduled to be generated on a recurring basis.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } }, { "name": "offset", "description": "Use offset and limit to restrict the number of users in the output. Offset can be used to specify the start record", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "description": "Use offset and limit to restrict the number of users in the output. Offset can be used to specify the start record" } }, { "name": "limit", "description": "Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response", "required": false, "schema": { "maximum": 100.0, "minimum": 0.0, "type": "integer", "default": 10, "description": "Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response" } }, { "name": "sorts", "description": "Use sort to get the reports in the response sorted in the particular order. for example, use '-GENERATED_DATE to sort the reports by generated date in descending order. And ‘GENERATED_DATE’ for ascending order. For descending order, the field name should be prefixed with '-'", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "REPORT_NAME", "-REPORT_NAME", "CREATED_DATE", "-CREATED_DATE" ], "type": "string" }, "default": "-CREATED_DATE", "description": "Use sort to get the reports in the response sorted in the particular order. for example, use '-GENERATED_DATE to sort the reports by generated date in descending order. And ‘GENERATED_DATE’ for ascending order. For descending order, the field name should be prefixed with '-'" } } ], "result": { "name": "reports_getScheduledReportsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "SearchScheduledReportResponse", "required": [ "data", "_links" ], "type": "object", "properties": { "data": { "minItems": 0, "type": "array", "items": { "title": "ScheduledReport", "required": [ "scheduledId", "reportName", "scheduleType", "createdBy", "createdDate", "lastAttemptedDate", "customerOrganizationId", "status", "parameters", "reports" ], "type": "object", "properties": { "scheduledId": { "type": "string", "description": "A unique UUID string denoting the id of the scheduled entry", "format": "uuid" }, "reportName": { "minLength": 1, "type": "string", "description": "Name of the report" }, "scheduleType": { "title": "ScheduleType", "enum": [ "ONE_TIME", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Scheduling strategy for the report to be generated." }, "period": { "title": "Period", "enum": [ "1_DAY", "7_DAYS", "14_DAYS", "30_DAYS", "90_DAYS", "180_DAYS", "1_YEAR", "CUSTOM", "NONE" ], "type": "string", "description": "Date range which the report should be generated" }, "createdBy": { "type": "string", "description": "Person/Entity who created this entry first time" }, "createdDate": { "type": "string", "description": "Time when this entry was first created", "format": "date-time" }, "lastAttemptedDate": { "type": "string", "description": "Last attempted date to trigger the report generation", "format": "date-time" }, "customerOrganizationId": { "minimum": 0.0, "type": "integer", "description": "Customer Organization Id" }, "forOrg": { "minimum": 1.0, "type": "integer", "description": "Customer Org Id where report is generated on behalf of" }, "forUser": { "type": "string", "description": "User key where report is generated on behalf of" }, "lastModifiedBy": { "type": "string", "description": "Person/Entity who modified this entry last time" }, "lastModifiedDate": { "type": "string", "description": "Last modified date of this entry", "format": "date-time" }, "numberOfFailedAttempts": { "maximum": 3.0, "minimum": 0.0, "type": "integer", "description": "Number of times the generation of report were failed" }, "status": { "title": "ScheduleStatus", "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED" ], "type": "string", "description": "Scheduling Status" }, "parameters": { "$ref": "#/components/schemas/Parameters_8d62e39d" }, "reports": { "$ref": "#/components/schemas/Reports" } }, "example": { "scheduledId": "806f281c-6295-465e-bd41-04559d4d4960", "reportName": "my_report", "scheduleType": "WEEKLY", "period": "30_DAYS", "createdBy": "john.doe", "createdDate": "2017-05-14T00:40:59.790Z", "lastAttemptedDate": "2018-07-02T21:59:15.045Z", "customerOrganizationId": 44010, "forOrg": 28120, "forUser": 12354, "lastModifiedBy": "john.doe", "lastModifiedDate": "2017-07-02T21:59:15.045Z", "numberOfFailedAttempts": 0, "status": "ACTIVE", "parameters": [ { "name": "adipisicing", "value": "Duis", "type": "STRING" }, { "name": "esse anim dolor et", "value": "velit Excepteur voluptate", "type": "ARRAY" }, { "name": "exercitation pariatur cupidatat anim in", "value": "labore esse", "type": "ARRAY" }, { "name": "exercitation est", "value": "magna quis", "type": "DOUBLE" }, { "name": "dolor nulla nisi ut eu", "value": "Duis mollit Lorem", "type": "DOUBLE" } ], "reports": [ { "reportId": "71df1306-94f9-4cbd-b6b0-735098bf7f87", "scheduledId": "772e5b73-3814-4604-8ae9-6f3eef114132", "createdBy": "ea sint fugi", "createdDate": "3738-09-09T05:31:51.735Z", "startTime": "3990-09-01T03:46:44.797Z", "status": "SUCCESS", "numberOfAttempts": 3, "parameters": [], "publisherInfo": {}, "lastAccessedBy": "sunt eu aute" }, { "reportId": "cff3620a-e3d6-4206-a504-1758bd400501", "scheduledId": "4ad6048f-3fc4-4fb9-8b66-22fba0bd62f1", "createdBy": "ullamco amet nostrud sint", "createdDate": "2918-11-28T03:33:08.736Z", "startTime": "4808-02-16T12:09:15.960Z", "status": "INACTIVE", "numberOfAttempts": 3, "parameters": [ { "name": "cillum Duis ex cupidatat voluptate", "value": "Ut", "type": "INT" } ], "location": "laboris nostrud", "errorMessage": "qui Excepteur", "endTime": "4909-04-15T03:51:50.570Z", "numberOfDownloads": 14336105, "publisherInfo": {} }, { "reportId": "4dbd3bea-25f8-485c-b06e-e9c06883b0d7", "scheduledId": "e572e79e-0a56-4052-879f-427ecb40dc85", "createdBy": "cupidatat", "createdDate": "4434-04-25T17:09:55.402Z", "startTime": "4243-01-15T02:51:52.654Z", "status": "INACTIVE", "numberOfAttempts": 0, "parameters": [ { "name": "pariatur aliqua ullamco dolor et", "value": "nisi deserunt dolore", "type": "STRING" }, { "name": "dolore amet ad", "value": "proident tempor", "type": "LONG" } ], "lastAccessedBy": "dolore exercitat", "errorMessage": "co", "endTime": "5058-03-30T22:21:23.213Z" }, { "reportId": "bc77cee9-0142-4954-afea-002d333b6440", "scheduledId": "98d33b3c-675e-4f1e-bfa7-ffdcd7b0aa18", "createdBy": "tempor", "createdDate": "2280-02-21T19:11:10.988Z", "startTime": "3750-11-06T20:13:33.607Z", "status": "ERROR", "numberOfAttempts": 1, "parameters": [ { "name": "qui non minim ut", "value": "ullamco Ut pariatur ipsum", "type": "INT" }, { "name": "nulla laborum deserunt", "value": "in dolore culpa consequat", "type": "ARRAY" } ], "location": "dolor", "lastAccessedDate": "4752-10-18T16:02:21.842Z", "publisherInfo": {}, "lastAccessedBy": "sunt ipsu", "numberOfDownloads": 51428315 } ] } }, "description": "List of records" }, "page": { "$ref": "#/components/schemas/Page" }, "_links": { "$ref": "#/components/schemas/Links_4fb063ac" } }, "example": { "data": [ { "scheduledId": "fb85e943-39da-4d62-afcf-46ed1077ce60", "reportName": "voluptate", "scheduleType": "DAILY", "createdBy": "cupidatat dolore adipisicing quis", "createdDate": "3269-06-06T22:03:28.837Z", "lastAttemptedDate": "3699-07-10T06:45:56.312Z", "customerOrganizationId": 48422050, "status": "INACTIVE", "parameters": [], "reports": [], "period": "1_DAY", "forOrg": 43909627, "forUser": 12354, "lastModifiedBy": "john.doe", "lastModifiedDate": "2017-07-02T21:59:15.045Z", "numberOfFailedAttempts": 1 }, { "scheduledId": "37f5fa8f-5fe8-40b3-91db-627bc053432c", "reportName": "eiusmod ullamco ipsum pariatur laborum", "scheduleType": "QUARTERLY", "createdBy": "occaecat dolor consectetur", "createdDate": "3109-05-27T03:32:30.773Z", "lastAttemptedDate": "3115-06-07T03:13:50.038Z", "customerOrganizationId": 77997941, "status": "INACTIVE", "parameters": [ { "name": "ex cu", "value": "mollit dolor laboris sint", "type": "ARRAY" }, { "name": "sed", "value": "pariatur anim dolor cupidatat consectetur", "type": "INT" }, { "name": "ipsum", "value": "minim Excepteur tempor ulla", "type": "INT" }, { "name": "Ut laborum", "value": "esse commodo adipisicing sed", "type": "INT" }, { "name": "anim Duis elit nisi irure", "value": "cillum", "type": "ARRAY" } ], "reports": [], "period": "7_DAYS" }, { "scheduledId": "ca32d0c1-4eee-4dd6-8d29-1401d91ce2af", "reportName": "fugiat magna cupidatat", "scheduleType": "DAILY", "createdBy": "esse tempor sunt mollit aute", "createdDate": "4740-12-25T16:47:30.142Z", "lastAttemptedDate": "2223-10-26T12:30:20.003Z", "customerOrganizationId": 25319222, "status": "ACTIVE", "parameters": [ { "name": "eiusmod exercitation in", "value": "fugiat e", "type": "BOOLEAN", "required": true }, { "name": "id irure L", "value": "sed", "type": "ARRAY" }, { "name": "eiusmod non proident", "value": "enim", "type": "LONG" }, { "name": "exercitation sint sunt", "value": "veniam", "type": "STRING" } ], "reports": [], "forOrg": 37814662, "forUser": 12354, "lastModifiedBy": "john.doe", "lastModifiedDate": "2017-07-02T21:59:15.045Z", "numberOfFailedAttempts": 0 }, { "scheduledId": "384ebadf-6cac-4258-9432-254d97a43edc", "reportName": "culpa qui enim quis ipsum", "scheduleType": "DAILY", "createdBy": "sint", "createdDate": "2054-06-06T17:58:19.383Z", "lastAttemptedDate": "2777-08-05T04:43:04.000Z", "customerOrganizationId": 3386629, "status": "ACTIVE", "parameters": [ { "name": "sint", "value": "amet", "type": "ARRAY" }, { "name": "incididunt aute tempor", "value": "anim ullamco", "type": "ARRAY", "required": true } ], "reports": [] } ], "page": { "total": 4, "limit": 5, "offset": 0, "sorts": [ "sint sit dolor", "ut est laborum", "magna voluptate", "velit nulla sed in voluptate" ] }, "_links": { "self": { "href": "esse aute" }, "next": { "href": "Duis dolor" }, "prev": { "href": "labore velit" } } }, "x-fastmcp-top-level-schema": "search-scheduled-report-response" } }, "x-mcp-annotations": { "title": "Get your Scheduled Reports", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "reports_scheduleReport", "summary": "Schedule New Report", "description": "Use this API to schedule a report to be generated on a recurring or ad hoc basis.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } }, { "name": "name", "description": "Report Name", "required": false, "schema": { "minLength": 1, "type": "string", "description": "Report Name" } }, { "name": "parameters", "description": "List of input parameters", "required": false, "schema": { "$ref": "#/components/schemas/Parameters_de963ee8" } }, { "name": "scheduleType", "description": "Scheduling strategy for the report to be generated.", "required": false, "schema": { "title": "ScheduleType", "enum": [ "ONE_TIME", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Scheduling strategy for the report to be generated." } }, { "name": "period", "description": "Date range which the report should be generated", "required": false, "schema": { "title": "Period", "enum": [ "1_DAY", "7_DAYS", "14_DAYS", "30_DAYS", "90_DAYS", "180_DAYS", "1_YEAR", "CUSTOM", "NONE" ], "type": "string", "description": "Date range which the report should be generated" } }, { "name": "control", "description": "Indicates whether user is entitled to use this report type.", "required": false, "schema": { "enum": [ "ALLOW", "DENY" ], "type": "string", "description": "Indicates whether user is entitled to use this report type." } }, { "name": "categories", "description": "The list of categories this definition belongs to", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "SECURITY", "SITE_AND_ENVIRONMENT", "ASSET", "POWER", "FINANCE" ], "type": "string" }, "description": "The list of categories this definition belongs to" } } ], "result": { "name": "reports_scheduleReportResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/ScheduledReport" } }, "x-mcp-annotations": { "title": "Schedule New Report", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "reports_updateScheduledReport", "summary": "Modify scheduled report parameters", "description": "Use this method to modify the report parameters and values of an existing scheduled report by the authenticated user.\n\nPart of the Equinix Reports Service API family (reports). The Reports APIs provide services to trigger and access various reports types available on Equinix Customer Portal. These report types can be triggered and accessed by a user depending on their permissions.", "tags": [ { "name": "reports" }, { "name": "Report Center" } ], "paramStructure": "by-name", "params": [ { "name": "scheduledId", "description": "Scheduled Id for the report entry", "required": true, "schema": { "description": "Scheduled Id for the report entry" } }, { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer '.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer '." } }, { "name": "name", "description": "Report Name", "required": false, "schema": { "minLength": 1, "type": "string", "description": "Report Name" } }, { "name": "parameters", "description": "List of input parameters", "required": false, "schema": { "$ref": "#/components/schemas/Parameters_de963ee8" } }, { "name": "scheduleType", "description": "Scheduling strategy for the report to be generated.", "required": false, "schema": { "title": "ScheduleType", "enum": [ "ONE_TIME", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Scheduling strategy for the report to be generated." } }, { "name": "period", "description": "Date range which the report should be generated", "required": false, "schema": { "title": "Period", "enum": [ "1_DAY", "7_DAYS", "14_DAYS", "30_DAYS", "90_DAYS", "180_DAYS", "1_YEAR", "CUSTOM", "NONE" ], "type": "string", "description": "Date range which the report should be generated" } }, { "name": "control", "description": "Indicates whether user is entitled to use this report type.", "required": false, "schema": { "enum": [ "ALLOW", "DENY" ], "type": "string", "description": "Indicates whether user is entitled to use this report type." } }, { "name": "categories", "description": "The list of categories this definition belongs to", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "enum": [ "SECURITY", "SITE_AND_ENVIRONMENT", "ASSET", "POWER", "FINANCE" ], "type": "string" }, "description": "The list of categories this definition belongs to" } } ], "result": { "name": "reports_updateScheduledReportResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/ScheduledReport" } }, "x-mcp-annotations": { "title": "Modify scheduled report parameters", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "search", "summary": "Search Equinix Docs", "description": "Search Equinix documentation using full-text search. Returns URLs that can be fetched with the 'fetch' tool to retrieve full content.", "tags": [ { "name": "docs" } ], "paramStructure": "by-name", "params": [ { "name": "query", "description": "The search query string", "required": true, "schema": { "type": "string", "description": "The search query string" } }, { "name": "limit", "description": "Maximum number of results to return (default: 8)", "required": false, "schema": { "default": 8, "type": "integer", "description": "Maximum number of results to return (default: 8)" } } ], "result": { "name": "searchResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "result": { "type": "string" } }, "required": [ "result" ], "type": "object", "x-fastmcp-wrap-result": true } } }, { "name": "securecabinet_createOrder", "summary": "Order a new Secure Cabinet deployment", "description": "Order a new Secure Cabinet deployment and recommended additional products at IBX data centers worldwide.\n\nPart of the Equinix Secure Cabinet API family (securecabinet). Order and manage Equinix Secure Cabinet colocation products.", "tags": [ { "name": "securecabinet" }, { "name": "colocation" }, { "name": "ordering" }, { "name": "orders" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Identifier of a billing account, with permission to order colocation products.", "required": true, "schema": { "minLength": 1, "type": "string", "description": "Identifier of a billing account, with permission to order colocation products.", "example": "132028" } }, { "name": "ibxCode", "description": "IBX data center identifier.", "required": true, "schema": { "pattern": "^[A-Z]{2}[0-9]+x?$", "type": "string", "description": "IBX data center identifier.", "example": "CH1" } }, { "name": "contractTerm", "description": "Contract term length.", "required": true, "schema": { "enum": [ "TERM_24_MONTHS", "TERM_36_MONTHS", "TERM_48_MONTHS", "TERM_60_MONTHS" ], "type": "string", "description": "Contract term length.", "example": "TERM_24_MONTHS" } }, { "name": "orderItem", "description": "Order details.", "required": true, "schema": { "required": [ "drawCapacity", "fabricPort", "numberOfCabinets", "cabinetDimensions", "pdus" ], "type": "object", "properties": { "drawCapacity": { "type": "number", "description": "Maximum, combined power draw of all cabinets in your order, measured in kVA. Applicable values, in 0.5 increments, depend on the IBX data center.", "format": "double", "example": 5 }, "fabricPort": { "type": "boolean", "description": "Indicates if a single, primary Fabric port should be included and delivered to one of the ordered cabinets.", "example": true }, "numberOfCabinets": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "description": "The number of ordered cabinets.", "example": 1 }, "cabinetDimensions": { "$ref": "#/components/schemas/CabinetDimensions" }, "pdus": { "type": "boolean", "description": "Indicates if an Equinix-recommended set of two PDUs, for single-phase circuit, per cabinet should be installed.", "example": true } }, "description": "Order details." } }, { "name": "Idempotency-Key", "description": "Caller-provided unique request token used to make order creation idempotent. A UUID is recommended.\n", "required": false, "schema": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Caller-provided unique request token used to make order creation idempotent. A UUID is recommended.\n", "example": "550e8400-e29b-41d4-a716-446655440000" } }, { "name": "customerReference", "description": "Supplementary identifier for your discretionary use. For example, your internal identifier.", "required": false, "schema": { "maxLength": 100, "type": "string", "description": "Supplementary identifier for your discretionary use. For example, your internal identifier.", "example": "My Reference" } }, { "name": "endCustomerName", "description": "End customer name. Applicable and required if a reseller billing account is used.", "required": false, "schema": { "type": "string", "description": "End customer name. Applicable and required if a reseller billing account is used.", "example": "Michael Scott" } }, { "name": "purchaseOrderNumber", "description": "Purchase order number. Optional, unless the billing account requires it.", "required": false, "schema": { "minLength": 1, "type": "string", "description": "Purchase order number. Optional, unless the billing account requires it.", "example": "8-132028" } }, { "name": "technicalContact", "description": "Contact person details for technical inquiries.", "required": false, "schema": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 50, "type": "string", "description": "First name.", "example": "John" }, "lastName": { "maxLength": 50, "type": "string", "description": "Last name.", "example": "Smith" }, "email": { "maxLength": 100, "type": "string", "description": "Email address.", "example": "john@smith.com" }, "phone": { "required": [ "number", "availability" ], "type": "object", "properties": { "number": { "maxLength": 40, "type": "string", "description": "A phone number in full international format.", "example": "4915126449706" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME", "CUSTOMER_BUSINESS_HOURS", "NOT_AVAILABLE" ], "type": "string", "description": "When is the best time to call.", "example": "WORK_HOURS" } }, "description": "Phone number details." } }, "description": "Contact person details for technical inquiries." } } ], "result": { "name": "securecabinet_createOrderResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "orderNumber" ], "type": "object", "properties": { "orderNumber": { "minLength": 1, "type": "string", "description": "Order Number", "example": "1-126546546546" } }, "x-fastmcp-top-level-schema": "OrderCreateResponse" } }, "x-mcp-annotations": { "title": "Order a new Secure Cabinet deployment", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "securecabinet_getProductsAvailability", "summary": "Secure Cabinet availability.", "description": "Returns the availability of Secure Cabinets and recommended additional products for provided billing account.\n\nPart of the Equinix Secure Cabinet API family (securecabinet). Order and manage Equinix Secure Cabinet colocation products.", "tags": [ { "name": "securecabinet" }, { "name": "availability" }, { "name": "colocation" }, { "name": "ordering" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumber", "description": "Identifier of a billing account, with permission to order colocation products.", "required": true, "schema": { "minLength": 1, "type": "string", "description": "Identifier of a billing account, with permission to order colocation products.", "example": "132028" } } ], "result": { "name": "securecabinet_getProductsAvailabilityResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "required": [ "ibx", "maximumNumberOfCabinetsToOrder", "minimumDrawCapacityPerCabinet", "maximumDrawCapacityPerCabinet", "cabinetDimensions", "acCircuitConfiguration" ], "type": "object", "properties": { "ibx": { "pattern": "^[A-Z]{2}[0-9]+x?$", "type": "string", "description": "IBX data center identifier.", "example": "CH1" }, "maximumNumberOfCabinetsToOrder": { "type": "integer", "description": "Maximum number of cabinets that can be ordered in one order in this ibx.", "example": 2 }, "minimumDrawCapacityPerCabinet": { "type": "number", "description": "The minimum power draw capacity per ordered cabinet.", "format": "double", "example": 5 }, "maximumDrawCapacityPerCabinet": { "type": "number", "description": "The maximum power draw capacity per ordered cabinet.", "format": "double", "example": 5 }, "cabinetDimensions": { "$ref": "#/components/schemas/CabinetDimensions" }, "acCircuitConfiguration": { "required": [ "phase", "receptacle", "soldAmperage", "voltage" ], "type": "object", "properties": { "voltage": { "type": "integer", "description": "Voltage numerical value", "example": 220 }, "soldAmperage": { "type": "number", "description": "Amperage Numerical Value", "format": "double", "example": 8.9 }, "phase": { "enum": [ "SINGLE" ], "type": "string", "description": "Circuit phase", "example": "SINGLE" }, "receptacle": { "type": "string", "description": "Receptacle type", "example": "IEC 60309 1P+N+E" } } }, "pduConfiguration": { "required": [ "model" ], "type": "object", "properties": { "model": { "type": "string", "description": "Model Code", "example": "UU30009L" } } }, "fabricPortSpeed": { "enum": [ "SPEED_1_GBPS", "SPEED_10_GBPS" ], "type": "string", "description": "Port speed", "example": "SPEED_1_GBPS" } }, "description": "Information about availability of products in one ibx. Missing pdu configuration means that we don't offer pdu\nthere. Missing fabric port speed means that fabric port is not available there.\n" }, "description": "A list of ibxs with information about product availabilities", "x-fastmcp-top-level-schema": "ProductsAvailabilities" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Secure Cabinet availability.", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "shipments_getLocation", "summary": "Get Locations(ibx, cage) Details for Shipment Based on Place Shipment Permission for User", "description": "This API is use to check user's permission's & access to ibx\n\nPart of the Equinix Shipment API family (shipments). Manage inbound and outbound equipment shipments to Equinix IBX data centers.", "tags": [ { "name": "shipments" }, { "name": "Shipment" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "detail", "description": "When enable this flag returns detailed permission with Cage & Cabinets. Default value is false", "required": false, "schema": { "type": "boolean", "description": "When enable this flag returns detailed permission with Cage & Cabinets. Default value is false" } }, { "name": "ibxs", "required": false, "schema": { "type": "string" } }, { "name": "cages", "required": false, "schema": { "type": "string" } } ], "result": { "name": "shipments_getLocationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "title": "Location", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "type": "string", "description": "Ibx Name", "example": "AM1" }, "cages": { "type": "array", "items": { "title": "Cage", "required": [ "cage" ], "type": "object", "properties": { "cage": { "type": "string", "description": "Cage", "example": "LD5:01:001MC3" }, "cageTypes": { "type": "array", "items": { "type": "string" }, "description": "Cage Types", "example": "Shared" }, "accounts": { "type": "array", "items": { "title": "Account", "required": [ "number", "name" ], "type": "object", "properties": { "number": { "type": "string", "description": "Account Number", "example": "136008" }, "name": { "type": "string", "description": "Name of Account", "example": "Service Corporation" }, "isCreditHold": { "type": "boolean", "description": "Is credit Hold account", "example": "false" }, "isPOBearing": { "type": "boolean", "description": "Is PO Bearing account", "example": "false" } } }, "description": "List of Accounts" } } }, "description": "List of cage" } } } } } } }, "x-mcp-annotations": { "title": "Get Locations(ibx, cage) Details for Shipment Based on Place Shipment Permission for User", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "shipments_outbound_shipment_submit", "summary": "Created Outbound Shipment.", "description": "This API is used to submit an Outbound Shipment order.\n\nPart of the Equinix Shipment API family (shipments). Manage inbound and outbound equipment shipments to Equinix IBX data centers.", "tags": [ { "name": "shipments" }, { "name": "Shipment" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "contacts", "required": false, "schema": { "$ref": "#/components/schemas/Contacts_fde38a92" } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/CustomerReferenceNumber" } }, { "name": "purchaseOrder", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_eba003e3" } }, { "name": "ibxLocation", "required": false, "schema": { "$ref": "#/components/schemas/IbxLocation" } }, { "name": "serviceDetails", "required": false, "schema": { "title": "Outbound Service Detail", "required": [ "estimatedDateTime", "shipmentDetails" ], "type": "object", "properties": { "outboundRequestDescription": { "maxLength": 4000, "minLength": 1, "type": "string" }, "estimatedDateTime": { "type": "string", "description": "Date and time of received event (ISO Date)
Cannot in Past. ", "format": "date-time" }, "shipmentDetails": { "required": [ "outboundType" ], "type": "object", "properties": { "outboundType": { "enum": [ "CARRIER", "CUSTOMER_CARRY" ], "type": "string", "description": "Outbound Type", "example": "CARRIER" }, "carrierName": { "enum": [ "UPS", "FEDEX", "DHL", "OTHER" ], "type": "string" }, "trackingNumber": { "maxLength": 100, "minLength": 1, "type": "string" }, "noOfBoxes": { "maximum": 100000.0, "minimum": 1.0, "type": "integer" }, "declaredValue": { "maxLength": 20, "minLength": 1, "type": "string" }, "labelExists": { "type": "boolean" }, "shipToAddress": { "required": [ "name", "address", "city", "state", "country", "zipCode", "phoneNumber", "carrierAccountNumber" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "address": { "maxLength": 100, "minLength": 1, "type": "string" }, "city": { "maxLength": 100, "minLength": 1, "type": "string" }, "state": { "maxLength": 100, "minLength": 1, "type": "string" }, "country": { "maxLength": 100, "minLength": 1, "type": "string" }, "zipCode": { "maxLength": 100, "minLength": 1, "type": "string" }, "phoneNumber": { "maxLength": 20, "minLength": 1, "type": "string" }, "carrierAccountNumber": { "maxLength": 100, "minLength": 1, "type": "string" } } }, "otherCarrierName": { "maxLength": 50, "minLength": 1, "type": "string" }, "uploadedLabel": { "$ref": "#/components/schemas/Attachment_0aac561a" }, "insureShipment": { "type": "boolean" }, "pickUpFromCageSuite": { "type": "boolean" }, "description": { "maxLength": 100, "minLength": 1, "type": "string" } } } } } }, { "name": "attachments", "description": "Attachments", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_34059b89" } } ], "result": { "name": "shipments_outbound_shipment_submitResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Shipment_Order_Response" } }, "x-mcp-annotations": { "title": "Created Outbound Shipment.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "shipments_shipment_inbound", "summary": "Inbound Shipment Order", "description": "This API is used to submit an Inbound Shipment order.\n\nPart of the Equinix Shipment API family (shipments). Manage inbound and outbound equipment shipments to Equinix IBX data centers.", "tags": [ { "name": "shipments" }, { "name": "Shipment" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. Only username and contactType are valid for ordering and notification contacts, all other attributes will be ignored.

Technical contact is optional. workPhoneCountryCode, workPhone and workPhonePrefToCall attributes are mandatory for Technical Contact(when Provided).

If notification contact is not available to pass, please use ordering contact as notification contact also.
", "required": false, "schema": { "minItems": 2, "type": "array", "items": { "$ref": "#/components/schemas/Contact_Info_12bbde9b" }, "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. Only username and contactType are valid for ordering and notification contacts, all other attributes will be ignored.

Technical contact is optional. workPhoneCountryCode, workPhone and workPhonePrefToCall attributes are mandatory for Technical Contact(when Provided).

If notification contact is not available to pass, please use ordering contact as notification contact also.
", "example": [ { "contactType": "ORDERING", "userName": "jondoe@test.com" }, { "contactType": "NOTIFICATION", "userName": "jondoe@test.com" }, { "contactType": "TECHNICAL", "name": "John Doe", "workPhone": "1111111", "workPhonePrefToCall": "ANYTIME", "mobilePhone": "1111111", "mobilePhonePrefToCall": "ANYTIME" } ] } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/CustomerReferenceNumber" } }, { "name": "purchaseOrder", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_eba003e3" } }, { "name": "ibxLocation", "required": false, "schema": { "$ref": "#/components/schemas/IbxLocation" } }, { "name": "attachments", "description": "Attachments", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_34059b89" } }, { "name": "serviceDetails", "required": false, "schema": { "title": "Inbound Service Detail", "required": [ "shipmentDetails", "estimatedDateTime" ], "type": "object", "properties": { "shipmentDetails": { "required": [ "noOfBoxes", "inboundType" ], "type": "object", "properties": { "noOfBoxes": { "maximum": 1e+19, "type": "integer", "description": "No of boxes" }, "isOverSized": { "type": "boolean", "description": "if Box is oversized", "example": true }, "description": { "maxLength": 100, "minLength": 1, "type": "string", "description": "description of inbound shipment" }, "trackingNumber": { "maxItems": 10, "minItems": 0, "type": "array", "items": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": "Tracking number", "example": "1,2,3" }, "inboundType": { "enum": [ "CARRIER", "CUSTOMER_CARRY" ], "type": "string", "description": "Inbound Type", "example": "CARRIER" }, "carrierName": { "enum": [ "FEDEX", "DHL", "UPS", "OTHER" ], "type": "string", "description": "Carrier Name of shipment", "example": "FEDEX" }, "otherCarrierName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Other Carrier Name" } } }, "deliverToCage": { "type": "boolean", "description": "Deliver To cage", "example": true }, "inboundRequestDescription": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Scope of work" }, "storageId": { "type": "string", "description": "Storage ID", "example": 123 }, "estimatedDateTime": { "type": "string", "description": "estimatedDateTime of Shipment (ISO Date)
Cannot in Past. ", "format": "date-time", "example": "2018-10-15T05:00:00.420-08:00" } }, "example": { "estimatedDateTime": "2018-10-15T05:00:00.420-08:00", "shipmentDetails": { "noOfBoxes": 10, "isOverSized": true, "description": "hello", "trackingNumber": [ "1235467869", "1", "4", "5" ], "inboundType": "CARRIER", "carrierName": "OTHER", "otherCarrierName": "test" }, "deliverToCage": true, "inboundRequestDescription": "hello" } } } ], "result": { "name": "shipments_shipment_inboundResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Shipment_Order_Response" } }, "x-mcp-annotations": { "title": "Inbound Shipment Order", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "shipments_shipment_pending", "summary": "Pending Storage Order", "description": "This API is used to submit the Pending Inbound Shipment order.\n\nPart of the Equinix Shipment API family (shipments). Manage inbound and outbound equipment shipments to Equinix IBX data centers.", "tags": [ { "name": "shipments" }, { "name": "Shipment" }, { "name": "colocation" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "shipmentDetails", "required": false, "schema": { "type": "array", "items": { "required": [ "storageId", "cage", "accountNumber", "deliverToCage" ], "type": "object", "properties": { "storageId": { "type": "string" }, "cage": { "type": "string" }, "accountNumber": { "type": "string" }, "deliverToCage": { "type": "boolean" }, "additionalDetails": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Scope of work" }, "customerReferenceNumber": { "$ref": "#/components/schemas/CustomerReferenceNumber" }, "purchaseInformation": { "maxLength": 30, "minLength": 1, "type": "string", "description": "Purchase Order Number", "example": "1234567890" } } } } }, { "name": "contacts", "required": false, "schema": { "$ref": "#/components/schemas/Contacts_fde38a92" } } ], "result": { "name": "shipments_shipment_pendingResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "title": "Pending Storage Order Response", "type": "array", "items": { "required": [ "orderNumber", "storageID", "Ibx", "cage", "accountNumber", "trackingNumber" ], "type": "object", "properties": { "OrderReferenceId": { "type": "string", "description": "Order Reference Id" }, "orderNumber": { "type": "string", "description": "Order Number", "example": "1-108124419634" }, "Id": { "type": "string", "description": "Order Id" }, "SRNumber": { "type": "string", "description": "SR Number" }, "storageID": { "type": "string" }, "Ibx": { "type": "string" }, "cage": { "type": "string" }, "accountNumber": { "type": "string" }, "trackingNumber": { "type": "string" } } }, "x-fastmcp-top-level-schema": "pending-storage-order-response" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Pending Storage Order", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "shipmentsv2_Schedule_inbound_or_outbound_shipment", "summary": "Schedule inbound or outbound shipment", "description": "This method schedules an inbound or outbound shipment for a user with shipments ordering permission.\n\nPart of the Equinix Shipments API family (shipmentsv2). Manage inbound and outbound equipment shipments to Equinix IBX data centers.", "tags": [ { "name": "shipmentsv2" }, { "name": "Shipments" }, { "name": "colocation" }, { "name": "shipments" } ], "paramStructure": "by-name", "params": [ { "name": "type", "description": "Type of shipment to be scheduled.", "required": false, "schema": { "enum": [ "INBOUND", "OUTBOUND" ], "type": "string", "description": "Type of shipment to be scheduled.", "example": "INBOUND" } }, { "name": "requestedDateTime", "description": "Date and time of shipment schedule in UTC timezone in ISO 8601 format.", "required": false, "schema": { "type": "string", "description": "Date and time of shipment schedule in UTC timezone in ISO 8601 format.", "format": "date-time", "example": "2020-05-22T19:23:51.000Z" } }, { "name": "cageId", "description": "ID of cage where shipment is to be delivered to or retrieve from.", "required": false, "schema": { "type": "string", "description": "ID of cage where shipment is to be delivered to or retrieve from.", "example": "DC2:01:001030" } }, { "name": "details", "required": false, "schema": { "anyOf": [ { "required": [ "carrier", "carrierTrackingNumbers", "numberOfBoxes" ], "allOf": [ { "type": "object", "allOf": [ { "properties": { "carrier": { "enum": [ "DHL", "FEDEX", "UPS", "OTHER", "CUSTOMER_CARRIER" ], "type": "string", "description": "The carrier service that will be delivering the shipment." }, "carrierTrackingNumbers": { "type": "array", "items": { "maxLength": 100, "type": "string", "example": "123466ABCXYZ" }, "description": "Shipment tracking number. This field is optional when carrier is of `CUSTOMER_CARRIER`" } } }, { "$ref": "#/components/schemas/Details_e41b369e" }, { "properties": { "cageDelivery": { "type": "boolean", "description": "When set to `true`, shipment will be delivered to cage.", "default": false } } } ] } ] }, { "required": [ "carrier" ], "allOf": [ { "allOf": [ { "properties": { "carrier": { "enum": [ "DHL", "FEDEX", "UPS", "OTHER", "CUSTOMER_CARRIER" ], "type": "string", "description": "The carrier service that will be delivering the shipment." } } }, { "type": "object", "properties": { "carrierTrackingNumbers": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "maxLength": 100, "type": "string", "example": "123466ABCXYZ" }, "description": "Shipment tracking number. This field is optional when carrier is of `CUSTOMER_CARRIER`" }, "carrierName": { "maxLength": 50, "minLength": 2, "type": "string", "description": "This field should be used to specify carrier name when `carrier` is of `OTHER`.", "example": "carrier_name" }, "numberOfBoxes": { "maximum": 100000.0, "type": "number", "description": "Number of boxes to be sent. This field is optional when carrier is of `CUSTOMER_CARRIER` ", "example": "10" }, "declaredValue": { "type": "number", "description": "Declared value of outbound shipment in dollars. This field is optional when carrier is of `CUSTOMER_CARRIER`", "example": "100" } } }, { "properties": { "declaredValueCurrency": { "$ref": "#/components/schemas/Currency_Code" }, "requirePickup": { "type": "boolean", "description": "When set to `true`, Equinix will pick up shipment from your cage. Note that this will incur additional Smarthands fees based on contract rate.", "default": false }, "insureShipment": { "type": "boolean", "description": "When set to `true`, Equinix will insure outbound shipment .Note that this will incur additional Smarthands fees based on contract rate.", "default": false }, "shipmentLabelRequired": { "type": "boolean", "description": "When set to `true`, Equinix will print shipment label for your package. Address information for shipment label can be uploaded as an label attachment or as address fields.", "default": true }, "shipmentAttachmentId": { "type": "string", "description": "Attachment ID of uploaded shipment label. Refer to Attachment API on how to upload documents via API" }, "shipmentAddress": { "$ref": "#/components/schemas/Address_details" } } } ] } ] } ] } }, { "name": "accountNumber", "description": "Customer account number. This is required if cage is shared.", "required": false, "schema": { "type": "string", "description": "Customer account number. This is required if cage is shared.", "example": 224552 } }, { "name": "description", "description": "Any additional information that the technician may need to complete your request", "required": false, "schema": { "maxLength": 4000, "minLength": 10, "type": "string", "description": "Any additional information that the technician may need to complete your request", "example": "Package is heavy, please operate with caution" } }, { "name": "customerReferenceId", "description": "Customer Reference Number / External Reference Number", "required": false, "schema": { "maxLength": 40, "minLength": 1, "type": "string", "description": "Customer Reference Number / External Reference Number", "example": "048837d6-4cd8-401f-ba41-a4ac015c3f3e" } }, { "name": "purchaseOrder", "description": "Purchase order required only when the Account PO Bareing", "required": false, "schema": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "EXEMPTED", "NEW", "EXISTING" ], "type": "string", "description": "Type of the Purchase Order", "example": "EXISTING" }, "number": { "type": "string", "description": "Purchase order number is applicable when `type` is `EXISTING` or `NEW`." }, "amount": { "type": "number", "description": "The purchase order amount. This is only applicable when `type` is `NEW`", "example": "2200" }, "startDate": { "type": "string", "description": "The start date for which the purchase order is valid for. This is only applicable when `type` is `NEW`", "format": "date", "example": "2020-05-22" }, "endDate": { "type": "string", "description": "The end date for which the purchase order is valid for. This is only applicable when `type` is `NEW`.", "format": "date", "example": "2021-05-22" }, "attachmentId": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Attachment ID of Purchase Order document.", "example": "8d0bef9c-cca9-11ea-87d0-0242ac130003" } }, "description": "Purchase order required only when the Account PO Bareing" } }, { "name": "attachments", "description": "Additional attachments that is required to facilitate scheduled shipments such as instruction manual or photos. To learn about including attachments in your request, see POST Attachment API. ", "required": false, "schema": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_3a0c3cd7" }, "description": "Additional attachments that is required to facilitate scheduled shipments such as instruction manual or photos. To learn about including attachments in your request, see POST Attachment API. " } }, { "name": "contacts", "description": "The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, provide the Techical contact and Notificition contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users).", "required": false, "schema": { "type": "array", "items": { "anyOf": [ { "required": [ "registeredUsers", "type" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "type": "array", "items": { "type": "string", "example": "john_doe" }, "description": "Username of a registered user." }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Technical contact's availability to receive calls.", "default": "ANYTIME" }, "timezone": { "$ref": "#/components/schemas/Timezone_fd353090" }, "type": { "enum": [ "NOTIFICATION", "TECHNICAL" ], "type": "string", "description": "Type of contact.", "default": "NOTIFICATION" } }, "description": "Contact information of a registered user. Ensure that the user status of this contact is approved, active or locked." }, { "required": [ "details", "firstName", "lastName", "type" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "type": { "enum": [ "TECHNICAL" ], "type": "string", "description": "Type of contact.", "default": "TECHNICAL" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Technical contact's availability to receive calls.", "default": "WORK_HOURS" }, "timezone": { "$ref": "#/components/schemas/Timezone_fd353090" }, "details": { "maxItems": 3, "minItems": 2, "type": "array", "items": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "enum": [ "PHONE", "MOBILE", "EMAIL" ], "type": "string", "description": "Communications Type", "example": "PHONE" }, "value": { "type": "string", "description": "Unique identifier of related type.", "example": "+65-1111111" } }, "description": "Contact details." }, "description": "Reference of the related party, could be a party reference or a party role reference" } }, "description": "Contact information of a non-registered contact, including contact details." } ] }, "description": "The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, provide the Techical contact and Notificition contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users)." } } ], "result": { "name": "shipmentsv2_Schedule_inbound_or_outbound_shipmentResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Schedule inbound or outbound shipment", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "shipmentsv2_Update_inbound_or_outbound_shipment", "summary": "Update inbound or outbound shipment", "description": "This method modifies an inbound or outbound shipment for a user with shipments ordering permission.\n\nPart of the Equinix Shipments API family (shipmentsv2). Manage inbound and outbound equipment shipments to Equinix IBX data centers.", "tags": [ { "name": "shipmentsv2" }, { "name": "Shipments" }, { "name": "colocation" }, { "name": "shipments" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the shipments order", "required": true, "schema": { "type": "string", "description": "Identifier of the shipments order" } }, { "name": "contacts", "required": false, "schema": { "$ref": "#/components/schemas/Contacts_d5d3518a" } }, { "name": "requestedDateTime", "description": "Date the requested date and time.", "required": false, "schema": { "type": "string", "description": "Date the requested date and time.", "format": "date-time", "example": "2020-05-22T19:23:51.000Z" } }, { "name": "details", "required": false, "schema": { "anyOf": [ { "type": "object", "allOf": [ { "properties": { "carrier": { "enum": [ "DHL", "FEDEX", "UPS", "OTHER" ], "type": "string", "description": "The carrier service that will be delivering the shipment." }, "carrierTrackingNumbers": { "type": "array", "items": { "maxLength": 100, "type": "string", "example": "123466ABCXYZ" }, "description": "Shipment tracking number." } } }, { "$ref": "#/components/schemas/Details_e41b369e" }, { "properties": { "cageDelivery": { "type": "boolean", "description": "When set to `true`, shipment will be delivered to cage." } } } ] }, { "allOf": [ { "properties": { "carrier": { "enum": [ "DHL", "FEDEX", "UPS", "OTHER" ], "type": "string", "description": "The carrier service that will be delivering the shipment." }, "carrierTrackingNumbers": { "maxItems": 1, "minItems": 1, "type": "array", "items": { "maxLength": 100, "type": "string", "example": "123466ABCXYZ" }, "description": "Shipment tracking number." }, "carrierName": { "maxLength": 50, "minLength": 2, "type": "string", "description": "This field should be used to specify carrier name when `carrier` is of `OTHER`.", "example": "carrier_name" }, "numberOfBoxes": { "maximum": 100000.0, "type": "number", "description": "Number of boxes to be sent. ", "example": "10" }, "declaredValue": { "type": "number", "description": "Declared value of outbound shipment in dollars. ", "example": "100" }, "declaredValueCurrency": { "$ref": "#/components/schemas/Currency_Code" }, "requirePickup": { "type": "boolean", "description": "When set to `true`, Equinix will pick up shipment from your cage. Note that this will incur additional Smarthands fees based on contract rate." }, "insureShipment": { "type": "boolean", "description": "When set to `true`, Equinix will insure outbound shipment .Note that this will incur additional Smarthands fees based on contract rate." }, "shipmentAttachmentId": { "type": "string", "description": "Attachment ID of uploaded shipment label. Refer to Attachment API on how to upload documents via API" }, "shipmentAddress": { "$ref": "#/components/schemas/Address_details" } } } ] } ] } } ], "result": { "name": "shipmentsv2_Update_inbound_or_outbound_shipmentResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update inbound or outbound shipment", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_getLocation", "summary": "Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user", "description": "Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "detail", "description": "When enable this flag returns detailed permission with Cage & Cabinets.", "required": false, "schema": { "type": "boolean", "default": false, "description": "When enable this flag returns detailed permission with Cage & Cabinets." } }, { "name": "ibxs", "description": "Example: AM1,AM2", "required": false, "schema": { "type": "string", "description": "Example: AM1,AM2" } }, { "name": "cages", "description": "Example: AM1:02:002MC1", "required": false, "schema": { "type": "string", "description": "Example: AM1:02:002MC1" } } ], "result": { "name": "smarthands_getLocationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "title": "Location", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "type": "string", "description": "Ibx Name", "example": "AM1" }, "cages": { "type": "array", "items": { "title": "Cage", "required": [ "cage" ], "type": "object", "properties": { "cage": { "type": "string", "description": "Cage or Suite", "example": "LD5:01:001MC3" }, "cageTypes": { "type": "array", "items": { "type": "string" }, "description": "Cage Types", "example": "Shared" }, "accounts": { "type": "array", "items": { "title": "Account", "required": [ "number", "name" ], "type": "object", "properties": { "number": { "type": "string", "description": "Account Number", "example": "136008" }, "name": { "type": "string", "description": "Name of Account", "example": "Service Corporation" }, "isCreditHold": { "type": "boolean", "description": "Is credit Hold account", "example": "false" }, "isPOBearing": { "type": "boolean", "description": "Is PO Bearing account", "example": "false" }, "cabinets": { "type": "array", "items": { "title": "Cabinets", "type": "object", "properties": { "cabinet": { "type": "string", "description": "Cabinet Number", "example": "LD5:01:001MC3:0718" }, "cabinetType": { "type": "string", "description": "Cabinet Type, Eg. Regular, Demarc" } } }, "description": "List of Cabinets" } } }, "description": "List of Accounts" } } }, "description": "List of cage" } } } } } } }, "x-mcp-annotations": { "title": "Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandCableRequestOrder", "summary": "This API is used to request cables per your specifications for your equipment.", "description": "This API is used to request cables per your specifications for your equipment.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Please fill out the Media Type, Connector Type and Length (Specify in cm or ft) for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 10 cables, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'Media Type', 'Connector Type' and 'Length (feet/cm)' objects are mandatory.", "required": false, "schema": { "required": [ "quantity", "scopeOfWork" ], "type": "object", "properties": { "mediaType": { "enum": [ "Multi-mode 62.5mic", "Multi-mode 50mic", "Single-mode", "Cat-5", "Cat-6", "Coax", "POTS", "T1", "E1" ], "type": "string", "description": "Media Type." }, "connectorType": { "enum": [ "RJ45", "SC", "LC", "BNC", "Other" ], "type": "string", "description": "Connector Type." }, "length": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Length (feet/cm).", "example": "20 ft" }, "quantity": { "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", ">10" ], "type": "string", "description": "Quantity" }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } }, "description": "Please fill out the Media Type, Connector Type and Length (Specify in cm or ft) for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 10 cables, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'Media Type', 'Connector Type' and 'Length (feet/cm)' objects are mandatory." } } ], "result": { "name": "smarthands_handleSmartHandCableRequestOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "This API is used to request cables per your specifications for your equipment.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandCageCleanupOrder", "summary": "Request trash removal or cage cleanup", "description": "This API is used to request trash removal or cage cleanup\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "minItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/Contact_Info_4b42a509" }, "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal." } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Cage Cleanup", "required": false, "schema": { "required": [ "permissionToDiscardBoxes", "dampMoistMopRequired", "scopeOfWork" ], "type": "object", "properties": { "permissionToDiscardBoxes": { "type": "boolean", "description": "Permission To Discard Boxes?", "example": false }, "dampMoistMopRequired": { "type": "boolean", "description": "Is Damp Moist Mop Requested?", "example": true }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } }, "description": "Cage Cleanup" } } ], "result": { "name": "smarthands_handleSmartHandCageCleanupOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request trash removal or cage cleanup", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandCageEscortOrder", "summary": "Request a patch cable to be moved between devices", "description": "This API is used to request a patch cable to be moved between devices\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Escort to Open Cage/Open Cabinet", "required": false, "schema": { "required": [ "durationVisit", "openCabinetForVisitor", "scopeOfWork", "supervisionReqForVisitor", "workVisitOrderNumber" ], "type": "object", "properties": { "durationVisit": { "enum": [ "30 Minutes", "60 Minutes", "90 Minutes", "2 Hours", "2 Hours 30 Minutes", "3 Hours", "3 Hours 30 Minutes", "4 Hours" ], "type": "string", "description": "Duration of the visit for the Visitor" }, "openCabinetForVisitor": { "type": "boolean", "description": "Open the Cabinet for the Visitor?", "example": false }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" }, "supervisionReqForVisitor": { "type": "boolean", "description": "Supervision Required For the Visitor?", "example": false }, "workVisitOrderNumber": { "pattern": "^[ A-Za-z0-9~!|\\[\\]@#$%^&*()_+:\"<>?\\/.,;'=\\-\\{\\}`]{1,200}$", "type": "string", "description": "Work Visit Order Number", "example": "1-108050984499" } }, "description": "Escort to Open Cage/Open Cabinet" } } ], "result": { "name": "smarthands_handleSmartHandCageEscortOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request a patch cable to be moved between devices", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandLocatePackageOrder", "summary": "Get the location of your package(s) at an IBX.", "description": "This API is used to get the location of your package(s) at an IBX.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Shipment Unpacking", "required": false, "schema": { "required": [ "shipmentOrderNumber", "trackingNumber", "possibleLocation", "packageDescription", "scopeOfWork" ], "type": "object", "properties": { "shipmentOrderNumber": { "pattern": "^[ A-Za-z0-9~!|\\[\\]@#$%^&*()_+:\"<>?\\/.,;'=\\-\\{\\}`]{1,50}$", "type": "string", "description": "Inbound Shipment Order Number", "example": "1-1111111111" }, "trackingNumber": { "pattern": "^[ A-Za-z0-9~!|\\[\\]@#$%^&*()_+:\"<>?\\/.,;'=\\-\\{\\}`]{1,200}$", "type": "string", "description": "Tracking Number", "example": "323-12121" }, "possibleLocation": { "pattern": "^[ A-Za-z0-9~!|\\[\\]@#$%^&*()_+:\"<>?\\/.,;'=\\-\\{\\}`]{1,200}$", "type": "string", "description": "Possible Location", "example": "Near cabinet 1010" }, "packageDescription": { "pattern": "^[ A-Za-z0-9~!|\\[\\]@#$%^&*()_+:\"<>?\\/.,;'=\\-\\{\\}`]{1,200}$", "type": "string", "description": "Package Description", "example": "It's small box with 1kg weight." }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } }, "description": "Shipment Unpacking" } } ], "result": { "name": "smarthands_handleSmartHandLocatePackageOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Get the location of your package(s) at an IBX.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandMoveJumperCableOrder", "summary": "This API is used to request a patch cable to be moved between devices.", "description": "This API is used to request a patch cable to be moved between devices.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Move Jumper Cable Service Details Object. Please fill out the Cable ID, Current Device (Name, Slot, Port) and New Device (Name, Slot, Port) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'currentDeviceDetails' and 'newDeviceDetails' objects are mandatory.", "required": false, "schema": { "required": [ "quantity", "scopeOfWork" ], "type": "object", "properties": { "quantity": { "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "12+" ], "type": "string", "description": "Quantity." }, "cableId": { "type": "string", "description": "Enter Cable ID or ‘None’ if not applicable. This field is mandatory if 'Quantity' is 1.", "example": "A01-5-10" }, "currentDeviceDetails": { "$ref": "#/components/schemas/Device_0c0510f1" }, "newDeviceDetails": { "$ref": "#/components/schemas/Device_0c0510f1" }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } }, "description": "Move Jumper Cable Service Details Object. Please fill out the Cable ID, Current Device (Name, Slot, Port) and New Device (Name, Slot, Port) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If 'Quantity' is 1, then below 'currentDeviceDetails' and 'newDeviceDetails' objects are mandatory." } } ], "result": { "name": "smarthands_handleSmartHandMoveJumperCableOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "This API is used to request a patch cable to be moved between devices.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandOrder", "summary": "Request equipment installation per your specifications by an IBX Technician", "description": "Request equipment installation per your specifications by an IBX Technician\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "required": false, "schema": { "required": [ "deviceLocation", "elevationDrawingAttached", "installationPoint", "installedEquipmentPhotoRequired", "mountHardwareIncluded", "patchDevices", "powerItOn", "scopeOfWork" ], "type": "object", "properties": { "deviceLocation": { "type": "string", "description": "Device Location", "example": "abc location" }, "elevationDrawingAttached": { "type": "boolean", "description": "Elevation drawing attached?", "example": false }, "installationPoint": { "type": "string", "description": "Installation Point", "example": "abc" }, "installedEquipmentPhotoRequired": { "type": "boolean", "description": "Installed Equipment Photo Required?", "example": false }, "mountHardwareIncluded": { "type": "boolean", "description": "Mount hardware included?", "example": true }, "patchDevices": { "type": "boolean", "description": "Patch Devices?", "example": true }, "patchingInfo": { "type": "string", "description": "Patching info", "example": "Patch my equipment" }, "powerItOn": { "type": "boolean", "description": "Power it on?", "example": true }, "needSupportFromASubmarineCableStationEngineer": { "title": "Need Support From Submarine Cable Station Engineer", "type": "boolean", "description": "This flag is only applicable to Submarine Cable IBXs", "example": false }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } } } } ], "result": { "name": "smarthands_handleSmartHandOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request equipment installation per your specifications by an IBX Technician", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandOthersOrder", "summary": "Request a Smart Hands order not listed in catalogue", "description": "This API is used to request a Smart Hands order not listed in catalogue\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Other", "required": false, "schema": { "required": [ "scopeOfWork" ], "type": "object", "properties": { "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } }, "description": "Other" } } ], "result": { "name": "smarthands_handleSmartHandOthersOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request a Smart Hands order not listed in catalogue", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandPatchCableInstallOrder", "summary": "Request installation of a cross connect patch cable by an IBX Technician.", "description": "Request installation of a cross connect patch cable by an IBX Technician.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "required": false, "schema": { "required": [ "crossConnects", "scopeOfWork" ], "type": "object", "properties": { "crossConnects": { "type": "array", "items": { "title": "Cross Connect for Install", "required": [ "serialNumber", "deviceCabinet", "deviceConnectorType", "deviceDetails", "devicePort" ], "type": "object", "properties": { "serialNumber": { "type": "string", "description": "Cross Connect serialNumber" }, "deviceCabinet": { "type": "string", "description": "Cross Connect Cabinet" }, "deviceConnectorType": { "type": "string", "description": "Cross Connect Device Connector Type" }, "deviceDetails": { "type": "string", "description": "Cross Connect Device Details" }, "devicePort": { "type": "string", "description": "Cross Connect Device Port" }, "lightLinkVerification": { "type": "boolean", "description": "Cross Connect Light Link Verification (Optional). Select this option if you would like a light reading provided and tx/rx verification after the cross connect is completed. In order to verify the correct transmit/receive alignment, please ensure your Z-Side Cross Connect Partner has their end fully extended to their equipment and their port is enabled. A separate billable activity will be created.", "example": true }, "scopeOfWork": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Scope of work" } } } } } } } ], "result": { "name": "smarthands_handleSmartHandPatchCableInstallOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request installation of a cross connect patch cable by an IBX Technician.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandPatchCableRemovalOrder", "summary": "Request removal of a cross connect cable by an IBX Technician.", "description": "Request removal of a cross connect cable by an IBX Technician.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "required": false, "schema": { "required": [ "crossConnects", "scopeOfWork" ], "type": "object", "properties": { "crossConnects": { "type": "array", "items": { "title": "Cross Connect for Removal", "required": [ "serialNumber", "deviceCabinet", "deviceConnectorType", "deviceDetails", "devicePort" ], "type": "object", "properties": { "serialNumber": { "type": "string", "description": "Cross Connect serialNumber" }, "deviceCabinet": { "type": "string", "description": "Cross Connect Cabinet" }, "deviceConnectorType": { "type": "string", "description": "Cross Connect Device Connector Type" }, "deviceDetails": { "type": "string", "description": "Cross Connect Device Details" }, "devicePort": { "type": "string", "description": "Cross Connect Device Port" }, "removePatchCableWithLiveTraffic": { "type": "boolean", "description": "Proceed with the de-install if live traffic is detected (Optional). By selecting this option, I agree to the terms of removal with live traffic. Please be advised that Equinix will complete the requested removal based on your instruction and will not be responsible for any service outages resulting from this removal.", "example": true }, "scopeOfWork": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Scope of work" } } } } } } } ], "result": { "name": "smarthands_handleSmartHandPatchCableRemovalOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request removal of a cross connect cable by an IBX Technician.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandPicturesDocumentOrder", "summary": "Request an IBX Technician to provide cage-related pictures or documentation.", "description": "Request an IBX Technician to provide cage-related pictures or documentation.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "required": false, "schema": { "required": [ "documentOnly", "scopeOfWork" ], "type": "object", "properties": { "cameraProvidedBy": { "enum": [ "Equinix", "Customer" ], "type": "string", "description": "Who is providing the camera? If documentOnly is false, this field is mandatory." }, "specificDateAndTime": { "type": "boolean", "description": "Would you like to request a specific date and time? If true, Scheduling should not be STANDARD. If documentOnly is false, this field is mandatory.", "example": false }, "documentOnly": { "type": "boolean", "description": "Do you need documents or pictures? Set true if you need documents.", "example": true }, "description": { "type": "string", "description": "Descrption of the Photo/Document. If documentOnly is false, this field is mandatory.", "example": "Cage Photo" }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } } } } ], "result": { "name": "smarthands_handleSmartHandPicturesDocumentOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request an IBX Technician to provide cage-related pictures or documentation.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandRunJumperCableOrder", "summary": "This API is used to request a jumper cable to be ran between devices.", "description": "This API is used to request a jumper cable to be ran between devices.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Move Jumper Cable Service Details Object. Please fill out the Media Type, Connector Type, Cable ID(optional), 'Should Equinix provide you Tx/Rx light levels, Yes Or No?', Devices to Connect details for Device#1 (Name/Panel, Device Slot, Device Ports) and Device#2(Optional) (Name/Panel, Device Slot, Device Ports) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. If any device is being shipped to Equinix, please include the shipment number. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If ‘Quantity’ is 1, then ‘Jumper Type’, Media Type, Connector Type, 'Should Equinix provide you Tx/Rx light levels?' and Device details are mandatory.", "required": false, "schema": { "required": [ "quantity", "scopeOfWork" ], "type": "object", "properties": { "quantity": { "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "12+" ], "type": "string", "description": "Quantity." }, "jumperType": { "enum": [ "Jumper", "Pre-Wiring", "Patch Cable", "Other" ], "type": "string", "description": "Jumper Type" }, "mediaType": { "enum": [ "Multi-mode 62.5mic", "Multi-mode 50mic", "Single-mode", "Cat-5", "Cat-6", "Coax", "POTS", "T1", "E1" ], "type": "string", "description": "Media Type" }, "connector": { "enum": [ "RJ45", "SC", "LC", "BNC", "Other" ], "type": "string", "description": "Connector Type" }, "cableId": { "type": "string", "description": "Cable ID", "example": "A01-5-10" }, "provideTxRxLightLevels": { "type": "boolean", "description": "Provide Tx/Rx Light Levels", "example": true }, "deviceDetails": { "type": "array", "items": { "$ref": "#/components/schemas/Device_0c0510f1" } }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" } }, "description": "Move Jumper Cable Service Details Object. Please fill out the Media Type, Connector Type, Cable ID(optional), 'Should Equinix provide you Tx/Rx light levels, Yes Or No?', Devices to Connect details for Device#1 (Name/Panel, Device Slot, Device Ports) and Device#2(Optional) (Name/Panel, Device Slot, Device Ports) details for each jumper cable and attach it to the form or complete scope of work text box when 'Quantity' is greater than 1. If any device is being shipped to Equinix, please include the shipment number. You may mix jumper types but if you require more than 12 jumpers ran, the site will contact you for scheduling of your request based on parts and availability. Please select the best option for your scheduling needs. If ‘Quantity’ is 1, then ‘Jumper Type’, Media Type, Connector Type, 'Should Equinix provide you Tx/Rx light levels?' and Device details are mandatory." } } ], "result": { "name": "smarthands_handleSmartHandRunJumperCableOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "This API is used to request a jumper cable to be ran between devices.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_handleSmartHandShipmentUnpackOrder", "summary": "Request inbound shipment unpacking and packaging disposal.", "description": "This API is used to request inbound shipment unpacking and packaging disposal.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "$ref": "#/components/schemas/Customer_Reference_Number" } }, { "name": "purchaseOrder", "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required", "required": false, "schema": { "$ref": "#/components/schemas/Purchase_Order_0d6c8f3e" } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "$ref": "#/components/schemas/IBX_Location" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "required": false, "schema": { "$ref": "#/components/schemas/Order_Contacts_Array" } }, { "name": "schedule", "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests.", "required": false, "schema": { "$ref": "#/components/schemas/Schedule_Info" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_Array" } }, { "name": "serviceDetails", "description": "Shipment Unpacking", "required": false, "schema": { "required": [ "inboundShipmentOrderNumber", "discardShipmentMaterial", "copyOfPackingSlipNeeded", "scopeOfWork" ], "type": "object", "properties": { "inboundShipmentOrderNumber": { "pattern": "^[ A-Za-z0-9~!|\\[\\]@#$%^&*()_+:\"<>?\\/.,;'=\\-\\{\\}`]{1,50}$", "type": "string", "description": "Inbound Shipment Order Number", "example": "1-12122121" }, "copyOfPackingSlipNeeded": { "type": "boolean", "description": "Copy of Packaging Slip Needed?", "example": false }, "scopeOfWork": { "title": "Scope Of Work", "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the character limit in this field.", "example": "Scope of work" }, "discardShipmentMaterial": { "type": "boolean", "description": "Discard Shipment Material?", "example": false } }, "description": "Shipment Unpacking" } } ], "result": { "name": "smarthands_handleSmartHandShipmentUnpackOrderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Request inbound shipment unpacking and packaging disposal.", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smarthands_smartHandTypes", "summary": "All supported smart hands types API.", "description": "Smart Hands Types API provides all types of supported smart hands.\n\nPart of the Equinix Smart Hands API family (smarthands). Order Equinix Smart Hands remote 'hands and eyes' support tasks performed by on-site technicians.", "tags": [ { "name": "smarthands" }, { "name": "Smarthands" }, { "name": "ordering" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } } ], "result": { "name": "smarthands_smartHandTypesResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "smarthands": { "type": "array", "items": { "title": "Smart hands Type", "required": [ "type", "typeDescription" ], "type": "object", "properties": { "type": { "enum": [ "EQUIPMENT_INSTALL", "CAGE_CLEANUP", "CAGE_ESCORT_OPEN_CABINET", "SHIPMENT_UNPACKING", "OTHER" ], "type": "string", "description": "Smarthand Type", "example": "EQUIPMENT_INSTALL" }, "typeDescription": { "type": "string", "description": "Description of Smarthand Type", "example": "EQUIPMENT_INSTALL" } } } } } } }, "x-mcp-annotations": { "title": "All supported smart hands types API.", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_createPowerAlertConfiguration", "summary": "Create a power alert configuration", "description": "Creates a new power alert configuration for the specified account and IBX.\nThe configuration defines the condition (event type and threshold) that triggers\nan alert and the list of recipients to be notified via email, SMS or API Subscription.\n\nAssets can be scoped at the CAGE, CABINET, or CIRCUIT level.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Power Events" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer account number", "required": true, "schema": { "type": "string", "description": "Customer account number", "example": "123456" } }, { "name": "ibx", "description": "IBX code where the alert should be monitored", "required": true, "schema": { "type": "string", "description": "IBX code where the alert should be monitored", "example": "SV5" } }, { "name": "section", "description": "Section type for the alert. Use POWER for power-related alerts.", "required": true, "schema": { "type": "string", "description": "Section type for the alert. Use POWER for power-related alerts.", "example": "POWER" } }, { "name": "condition", "description": "Defines the condition that triggers a power alert", "required": true, "schema": { "$ref": "#/components/schemas/Condition" } }, { "name": "recipients", "description": "List of recipients to be notified when the alert condition is met", "required": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientsItem" }, "description": "List of recipients to be notified when the alert condition is met" } }, { "name": "assets", "description": "Assets to monitor, scoped by level type (CAGE, CABINET, CIRCUIT)", "required": false, "schema": { "type": "object", "properties": { "CAGE": { "type": "array", "items": { "$ref": "#/components/schemas/CAGEItem" }, "description": "List of cage assets to monitor" }, "CABINET": { "type": "array", "items": { "$ref": "#/components/schemas/CAGEItem" }, "description": "List of cabinet assets to monitor" }, "CIRCUIT": { "type": "array", "items": { "$ref": "#/components/schemas/CAGEItem" }, "description": "List of circuit assets to monitor" } }, "description": "Assets to monitor, scoped by level type (CAGE, CABINET, CIRCUIT)" } } ], "result": { "name": "smartview_createPowerAlertConfigurationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "alertConfigurationUid": { "type": "string", "description": "Unique identifier of the newly created power alert configuration", "format": "uuid", "example": "9756a585-c3c1-4648-b2e1-7d8804912098" } }, "description": "Response returned after successfully creating a power alert configuration", "x-fastmcp-top-level-schema": "CreateAlertConfigurationCommandResponse" } }, "x-mcp-annotations": { "title": "Create a power alert configuration", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smartview_createSubscription", "summary": "Create subscription endpoint", "description": "The endpoint allows users to define and create a new streaming subscription for a given organization.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Streaming Subscription API" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "messageType", "description": "Message type for a given subscription", "required": false, "schema": { "$ref": "#/components/schemas/MessageType" } }, { "name": "channel", "description": "Subscription can be created using one channel.", "required": false, "schema": { "$ref": "#/components/schemas/Channel" } } ], "result": { "name": "smartview_createSubscriptionResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Create subscription endpoint", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smartview_deleteAlertConfiguration", "summary": "Delete a power alert configuration", "description": "Permanently deletes a power alert configuration identified by its `alertConfigurationUid`.\nDeleted configurations cannot be recovered. Consider pausing a configuration instead\nif you want to temporarily stop alerts without losing the configuration.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Power Events" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "alertConfigurationUid", "description": "Unique identifier (UUID) of the power alert configuration to delete", "required": true, "schema": { "type": "string", "example": "9756a585-c3c1-4648-b2e1-7d8804912098", "description": "Unique identifier (UUID) of the power alert configuration to delete" } } ], "result": { "name": "smartview_deleteAlertConfigurationResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete a power alert configuration", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_deleteSubscriptionById", "summary": "Delete subscription", "description": "This endpoint allows users to delete and remove an existing streaming subscription for a given organization.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Streaming Subscription API" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "id", "required": true, "schema": { "type": "string" } } ], "result": { "name": "smartview_deleteSubscriptionByIdResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete subscription", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getAffectedAsset", "summary": "Retrieve affected customers assets hierarchy", "description": "This endpoint returns information regarding the affected assets of customers for a given asset identifier\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Assets APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "customer account number", "required": true, "schema": { "type": "string", "description": "customer account number" } }, { "name": "ibx", "description": "ibx code", "required": true, "schema": { "type": "string", "description": "ibx code" } }, { "name": "assetId", "description": "asset id", "required": true, "schema": { "type": "string", "description": "asset id" } }, { "name": "classification", "description": "asset classification(Electrical, Mechanical)", "required": true, "schema": { "enum": [ "Electrical", "Mechanical" ], "type": "string", "description": "asset classification(Electrical, Mechanical)" } } ], "result": { "name": "smartview_getAffectedAssetResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "cages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Cage Unique Space Id", "example": "CH1:05:000430" }, "type": { "type": "string", "description": "type of the asset", "example": "cage" }, "cabinets": { "type": "array", "items": { "type": "object", "properties": { "name": { "enum": [ "CH1:05:000430:0105" ], "type": "string" }, "type": { "type": "string", "example": "cabinet" }, "circuits": { "type": "array", "items": { "type": "object", "properties": { "name": { "enum": [ "877484" ], "type": "string" }, "type": { "enum": [ "circuit" ], "type": "string" } } } } } } } } } }, "circuits": { "type": "array", "items": { "type": "object", "properties": { "name": { "enum": [ "877483" ], "type": "string" }, "type": { "enum": [ "circuit" ], "type": "string" } } } } } }, "status": { "$ref": "#/components/schemas/Status_362bd37d" } }, "x-fastmcp-top-level-schema": "HierarchyNodeForAssetAPI" } }, "x-mcp-annotations": { "title": "Retrieve affected customers assets hierarchy", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getAlerts", "summary": "System alerts search", "description": "This endpoint returns all system alerts in a paginated way\nallows narrowing returned results by submitting additional search filters.\n\nAllowed search filters:\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyOperatorDescription
/status=, INAlert status, INACTIVE or ACTIVE
/assetTagUid=, INAsset tag point unique id, example: PA8A.CB-CRITICAL-DB2:tripped
/assetTagDisplayName=, INActive tag reading display value, example: ALARM
/configuration/thresholdType=, INExample: DIGITAL
/configuration/conditionName=, INName given to the alarm condition. Example: ALARM
/asset/ibx=, INName of the IBX for which data is being requested, example: PA8A
/asset/assetUid=, IN, LIKEAsset unique ID, example: PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM
/activeProcessing/edgeCollectedOn=, >=, <=When tag reading was collected on source, example: 2022-09-23T13:40:53.449276Z
/asset/assetUnderMaintenance=, INAsset was under maintenance during alert processing, example: false
/asset/assetType=, INIndicates the template name for the asset, example: Circuit Breaker with Metering
/asset/assetClassification=, INThe class of assets this asset belongs to. Asset classification is electrical or mechanical, example: Electrical
\n\nAllowed search request sort options:\n- /status\n- /assetTagUid\n- /assetTagDisplayName\n- /configuration/thresholdType\n- /configuration/conditionName\n- /asset/ibx\n- /asset/assetUid\n- /activeProcessing/edgeCollectedOn\n- /asset/assetUnderMaintenance\n- /asset/assetType\n- /asset/assetClassification\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "DCIM System Alert" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/And_f944b113" }, "or": { "$ref": "#/components/schemas/And_f944b113" } } } }, { "name": "pagination", "required": false, "schema": { "required": [ "limit", "offset" ], "type": "object", "properties": { "offset": { "minimum": 0.0, "type": "integer", "description": "Starting index of an item. First item is offset 0. Default value for offset is 0.", "format": "int64", "example": 0 }, "limit": { "type": "integer", "description": "The maximum number of items to return starting from the index denotes by the offset item. Default value for limit is 20. Upper limit is 1000", "format": "int32", "example": 20 } } } }, { "name": "sort", "description": "Array of sorting conditions.", "required": false, "schema": { "type": "array", "items": { "required": [ "property" ], "type": "object", "properties": { "direction": { "enum": [ "ASC", "DESC" ], "type": "string", "description": "Direction of sorting. Default is ASC.", "example": "DESC" }, "property": { "type": "string", "description": "Property used for sorting the data.", "example": "/asset/ibx" } } }, "description": "Array of sorting conditions." } } ], "result": { "name": "smartview_getAlertsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Smartview_getAlertsResult" } }, "x-mcp-annotations": { "title": "System alerts search", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getAllSubscriptions", "summary": "Retrieve all subscriptions", "description": "This endpoint allows users to fetch details for all streaming subscriptions for a given organization.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Streaming Subscription API" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [], "result": { "name": "smartview_getAllSubscriptionsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "enum": [ "PENDING", "ACTIVE", "FAILED", "DELETE_IN_PROGRESS", "DELETED" ], "type": "string" }, "messageType": { "$ref": "#/components/schemas/MessageType" }, "channel": { "$ref": "#/components/schemas/Channel" }, "orgId": { "type": "string" }, "createdBy": { "type": "string" }, "createdDateTime": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "updatedDateTime": { "type": "string", "format": "date-time" } }, "description": "Subscription Response" } } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve all subscriptions", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getAsset", "summary": "Retrieve assets list information", "description": "This endpoint returns information about asset in a hierarchical structure (category / template / asset) based on the input account number, IBX code, cage and asset classification (Electrical, Mechanical).\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Assets APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "customer account number", "required": true, "schema": { "type": "string", "description": "customer account number" } }, { "name": "ibx", "description": "ibx code", "required": true, "schema": { "type": "string", "description": "ibx code" } }, { "name": "classification", "description": "asset classification (Electrical, Mechanical)", "required": true, "schema": { "enum": [ "Electrical", "Mechanical" ], "type": "string", "description": "asset classification (Electrical, Mechanical)" } }, { "name": "cages", "description": "cage unique space id to be used to filter the assets list assumed to be all cage unique space id if no value is sent.", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "cage unique space id to be used to filter the assets list assumed to be all cage unique space id if no value is sent." } } ], "result": { "name": "smartview_getAssetResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "classification": { "type": "string", "description": "asset classification for the Electrical and Mechanical", "example": "Mechanical" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "templates": { "type": "array", "items": { "type": "object", "properties": { "assets": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "enum": [ "CH1.Lead Chilled Water Manager", "CH1.Chiller-6" ], "type": "string", "description": "asset id for the asset" }, "ibx": { "enum": [ "CH1", "SG2" ], "type": "string", "description": "ibx code for the ibx in which the asset it present" }, "alarmStatus": { "enum": [ "NOT OK", "OK" ], "type": "string", "description": "alarm status for the asset" }, "resiliencyStatus": { "enum": [ "Resiliency as Designed", "Resiliency at Fault", "Resiliency in Maintenance" ], "type": "string", "description": "resiliency status for the asset" }, "alarmLastTriggeredTime": { "type": "string", "description": "datetime when the latest alarm on the asset was triggered", "example": "Aug 21,2017 04:52 AM" }, "alarmLastClearedTime": { "type": "string", "description": "datetime when the latest alarm on the asset was cleared", "example": "Aug 21,2017 05:52 AM" }, "primaryParentAsset": { "enum": [ "[CH1.UPS-5]", "[CH1.UPS-5,CH1.UPS-6]" ], "type": "string", "description": "the primary parent of the current asset it can be multi-valued (provided via comma separated asset id)" }, "alternateParentAsset": { "enum": [ "[CH1.UPS-13]", "[CH1.UPS-13,CH1.UPS-14]" ], "type": "string", "description": "the alternate parent of the current asset it can be multi-valued (provided via comma separated asset id)" } } } }, "templateId": { "type": "string", "description": "template id - unique identifier for the template", "example": "Cooling Plant" } }, "description": "template is a blueprint for an asset." } }, "categoryName": { "type": "string", "example": "Cooling" } } } } } }, "status": { "$ref": "#/components/schemas/Status_0819e0b5" } }, "x-fastmcp-top-level-schema": "AssetsList" } }, "x-mcp-annotations": { "title": "Retrieve assets list information", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getAssetDetails", "summary": "Retrieve details for an asset", "description": "This endpoint returns information about asset details including tag points lists for a given asset identifier.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Assets APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "customer account number", "required": true, "schema": { "type": "string", "description": "customer account number" } }, { "name": "ibx", "description": "ibx code", "required": true, "schema": { "type": "string", "description": "ibx code" } }, { "name": "classification", "description": "asset classification (Electrical, Mechanical)", "required": true, "schema": { "type": "string", "description": "asset classification (Electrical, Mechanical)" } }, { "name": "assetId", "description": "asset id", "required": true, "schema": { "type": "string", "description": "asset id" } } ], "result": { "name": "smartview_getAssetDetailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "assetId": { "type": "string", "description": "asset id for the Asset", "example": "CH1.Chiller-1" }, "assetType": { "type": "string", "description": "Template Name for the asset", "example": "Cooling" }, "userPrefTimeZone": { "type": "string", "description": "Time zone for the user", "example": "Asia/Katmandu" }, "tags": { "$ref": "#/components/schemas/Tags_b7839971" }, "lastMaintenanceDate": { "type": "string", "description": "Datetime when the machine had its last maintenance", "format": "date-time", "example": "2020-06-11T17:11:19" }, "manufacturerName": { "type": "string", "description": "Manufacturer name for the Asset", "example": "SMARDT" }, "equipmentModelNumber": { "type": "string", "description": "Equipment Model Number", "example": "SACAC110-3EXX-2A1-16A-010" }, "equipmentSerialNumber": { "type": "string", "description": "Equipment Serial Number", "example": "FF0010I233Q1276" }, "alarmLastTriggeredTime": { "type": "string", "description": "Datetime when the latest alarm was triggered on the asset", "example": "Aug 21,2017 04:38 AM" }, "alarmLastProcessedTime": { "type": "string", "description": "Datetime when the latest alarm was processed on the asset", "example": "Aug 21,2017 05:52 AM" } } }, "status": { "$ref": "#/components/schemas/Status_362bd37d" } }, "x-fastmcp-top-level-schema": "AssetDetailsGetResponse" } }, "x-mcp-annotations": { "title": "Retrieve details for an asset", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getCertificate", "summary": "Get subscription certificate endpoint", "description": "The Certificate endpoint allows users to retrieve certificates based on the specified channelType (AWS_IOT_CORE and WEBHOOK)\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Streaming Subscription API" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "channelType", "required": true, "schema": { "enum": [ "AWS_IOT_CORE", "WEBHOOK" ], "type": "string" } } ], "result": { "name": "smartview_getCertificateResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "channelType": { "enum": [ "AWS_IOT_CORE", "WEBHOOK" ], "type": "string" }, "certificateBase64": { "type": "string", "description": "Base64-encoded certificate", "format": "byte", "example": "Zm9vYmFy" }, "expiryDate": { "type": "string", "description": "The date and time when the certificate expires.", "format": "date-time", "example": "2024-12-31T23:59:59Z" } }, "description": "Subscription Certificate Response", "x-fastmcp-top-level-schema": "SubscriptionCertificateResponse" } }, "x-mcp-annotations": { "title": "Get subscription certificate endpoint", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getCurrentEnvironmentData", "summary": "Retrieve current environmental data", "description": "The API returns environment information on temperature and humidity from inputs (ibx, zone, cage, sensor)\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Environment APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": true, "schema": { "type": "string", "description": "IBX Code" } }, { "name": "levelType", "description": "Level Type", "required": true, "schema": { "enum": [ "IBX", "ZONE", "CAGE", "SENSOR" ], "type": "string", "description": "Level Type" } }, { "name": "levelValue", "description": "Level Value is ibxCode, zoneUsID, cageUsID, sensorid for levelType ibx, zone, cage, sensor resp.", "required": true, "schema": { "type": "string", "description": "Level Value is ibxCode, zoneUsID, cageUsID, sensorid for levelType ibx, zone, cage, sensor resp." } } ], "result": { "name": "smartview_getCurrentEnvironmentDataResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "$ref": "#/components/schemas/PayLoad_90f61cdf" }, "status": { "$ref": "#/components/schemas/Status_ae81556b" } }, "x-fastmcp-top-level-schema": "EnvironmentData" } }, "x-mcp-annotations": { "title": "Retrieve current environmental data", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getCurrentPowerData", "summary": "Retrieve current power consumption data", "description": "This powerData endpoint returns power consumption info (power consumption data with comparison data of current [% Kva] vs yesterday, lastWeek, lastMonth, lastQuarter) for input ibx, cage, cabinet, circuit.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "DCIM Power APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": true, "schema": { "type": "string", "description": "IBX Code" } }, { "name": "levelType", "description": "level type allowed value [ibx|cage|cabinet|circuit]", "required": true, "schema": { "enum": [ "ibx", "cage", "cabinet", "circuit" ], "type": "string", "description": "level type allowed value [ibx|cage|cabinet|circuit]" } }, { "name": "levelValue", "description": "level value - ibx code, cage unique space id, cabinet unique space id, serial number for level type ibx, cage, cabinet, circuit respectively.", "required": true, "schema": { "type": "string", "description": "level value - ibx code, cage unique space id, cabinet unique space id, serial number for level type ibx, cage, cabinet, circuit respectively." } } ], "result": { "name": "smartview_getCurrentPowerDataResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "ibx": { "type": "string", "description": "ibx code", "example": "ABC" }, "accountNo": { "type": "string", "description": "customer account number", "example": "ABC" }, "levelType": { "enum": [ "ibx", "cage", "cabinet", "circuit" ], "type": "string", "description": "power hierarchy node levelType linked to the power data", "example": "ibx" }, "levelValue": { "type": "string", "description": "power hierarchy node levelValue linked to the power data", "example": "ABC" }, "isAlarm": { "type": "string", "description": "returns boolean based on breakertip alarm", "example": "true" }, "kva": { "type": "number", "description": "power consumption in kva", "example": 54.402 }, "amps": { "type": "number", "description": "instantaneous current amp reading on circuits", "example": 123 }, "soldKva": { "type": "number", "description": "maximum amp draw allowable on a circuit", "example": 598.349 }, "cabinetRating": { "type": "number", "description": "maximum kVA draw allowed for the cabinet|cabinet description when the levelType is cabinet. Null otherwise.", "example": 341.54 }, "contractualKva": { "type": "number", "description": "The maximum power draw contractually allowable in a private cage.", "example": 341.54 }, "percentageKva": { "type": "number", "description": "calculated field kva / contractualKva", "example": 341.54 }, "comparisonData": { "$ref": "#/components/schemas/ComparisonData" }, "peakKvaLastSevenDays": { "type": "number", "example": 55.296 }, "peakKvaLastSevenDaysPercentage": { "type": "number", "example": 55.296 }, "peakKvaLastSevenDaysContractualKva": { "type": "number", "example": 55.296 }, "peakKvaLastSevenDaysTime": { "type": "integer", "example": 55 }, "soldAmps": { "type": "integer", "description": "circuit description when the levelType is circuit. Null otherwise.", "example": 123 }, "primaryKva": { "type": "number", "description": "the sum of instantaneous power draw reading on all the primary circuits within the levelType.", "example": 28.31 }, "redundantKva": { "type": "number", "description": "the sum of instantaneous power draw reading on all the redundant circuits within the levelType.", "example": 26.092 }, "kw": { "type": "string", "description": "measure of real power expressed in kilowatt applicable for ibxs that have capability of energy meter reading|value will be \"NA\" for AMER and APAC regions", "example": "NA" }, "powerFactor": { "type": "string", "description": "The ratio between real power and apparent power in a circuit.(kW/kVA)|value will be \"NA\" for AMER and APAC regions", "example": "NA" }, "readingTime": { "type": "string", "description": "date-time when the latest value was read in (epoc - milliseconds).", "example": "1497410400000" }, "lastUpdatedTime": { "type": "string", "description": "date-time when the latest value was updated (epoc - milliseconds).", "example": "1497410520000" }, "customerName": { "type": "string", "example": "ABC" } } }, "status": { "$ref": "#/components/schemas/Status_362bd37d" } }, "x-fastmcp-top-level-schema": "PowerData" } }, "x-mcp-annotations": { "title": "Retrieve current power consumption data", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getCurrentTagPoint", "summary": "Retrieve latest tag point data", "description": "This endpoint fetches and provides the most recent tag point information for a given tag identifier.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Assets APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "customer account number", "required": true, "schema": { "type": "string", "description": "customer account number" } }, { "name": "ibx", "description": "ibx code", "required": true, "schema": { "type": "string", "description": "ibx code" } }, { "name": "tagid", "description": "tag id is the unique identifier for the tag point", "required": true, "schema": { "type": "string", "description": "tag id is the unique identifier for the tag point" } } ], "result": { "name": "smartview_getCurrentTagPointResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Smartview_getCurrentTagPointResult" } }, "x-mcp-annotations": { "title": "Retrieve latest tag point data", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getLocationHierarchy", "summary": "Retrieve the Location Hierarchy", "description": "This endpoint returns the location hierarchy and provides data for invoking other APIs such as Environmental APIs that require location hierarchy information.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Hierarchy APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": false, "schema": { "type": "string", "description": "IBX Code" } } ], "result": { "name": "smartview_getLocationHierarchyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyNode" }, "x-fastmcp-top-level-schema": "LocationResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve the Location Hierarchy", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getPowerEvents", "summary": "Search power events", "description": "This endpoint returns all power events in a paginated way.\nAllows narrowing returned results by submitting additional query filters.\n\nResults can be filtered by IBX, status, and collection date. Both `limit` and `offset`\nare required to control pagination.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Power Events" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "limit", "description": "Number of records to retrieve per request", "required": true, "schema": { "type": "integer", "example": 100, "description": "Number of records to retrieve per request" } }, { "name": "offset", "description": "Record number to start retrieval from (0..N)", "required": true, "schema": { "type": "integer", "example": 0, "description": "Record number to start retrieval from (0..N)" } }, { "name": "ibx", "description": "List of IBX codes to filter power events (comma-separated)", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "example": [ "SV5", "NY1" ], "description": "List of IBX codes to filter power events (comma-separated)" } }, { "name": "status", "description": "List of statuses to filter power events (comma-separated). Possible values - ACTIVE, INACTIVE", "required": false, "schema": { "type": "array", "items": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" }, "example": [ "ACTIVE" ], "description": "List of statuses to filter power events (comma-separated). Possible values - ACTIVE, INACTIVE" } }, { "name": "edgeCollectedOn", "description": "Date filter to retrieve power events collected after a specific date (ISO 8601 format)", "required": false, "schema": { "type": "string", "example": "2024-01-01T00:00:00.000Z", "description": "Date filter to retrieve power events collected after a specific date (ISO 8601 format)" } } ], "result": { "name": "smartview_getPowerEventsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Database ID of the power event", "format": "int64", "example": 1042 }, "alertUid": { "type": "string", "description": "Unique identifier of the power event", "example": "SV5.CAGE-DRAW#EXCEEDS:95" }, "traceUid": { "type": "string", "description": "Trace unique ID related to the power event status change", "example": "1652686263561/SV5.CAGE-DRAW#EXCEEDS:95" }, "status": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string", "description": "Status of the power event", "example": "ACTIVE" }, "asset": { "type": "object", "properties": { "ibx": { "type": "string", "description": "IBX code where the asset is located", "example": "SV5" }, "assetUid": { "type": "string", "description": "Unique identifier of the asset", "example": "SV5:01:A1234" } }, "description": "Asset information associated with a power event" }, "activeProcessing": { "type": "object", "properties": { "edgeCollectedOn": { "type": "string", "description": "Timestamp when the power event data was collected at the edge", "format": "date-time", "example": "2024-01-15T08:30:00.000Z" } }, "description": "Processing time information for a power event" }, "category": { "type": "string", "description": "Category of the power event", "example": "POWER" }, "eventType": { "type": "string", "description": "Type of power event (e.g., CAGE_DRAW, CABINET_DRAW_TO_USABLE_KVA)", "example": "CAGE_DRAW" }, "conditionType": { "type": "string", "description": "Condition type that triggered the event (e.g., EXCEEDS, FALLS_BELOW)", "example": "EXCEEDS" }, "triggerValue": { "type": "string", "description": "The threshold value that was configured to trigger the event", "example": "95" }, "currentValue": { "type": "string", "description": "The actual value at the time the event was triggered", "example": "97.3" }, "accountNo": { "type": "string", "description": "Customer account number associated with the event", "example": "123456" } }, "description": "Represents a single power event" }, "description": "Array of power events" }, "limit": { "type": "integer", "description": "Number of records returned per request", "example": 100 }, "offset": { "type": "integer", "description": "Starting record index for this page", "example": 0 }, "totalCount": { "type": "integer", "description": "Total number of records matching the query", "example": 42 } }, "description": "Paginated response containing a list of power events", "x-fastmcp-top-level-schema": "PowerEventsPaginatedResponse" } }, "x-mcp-annotations": { "title": "Search power events", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getPowerHierarchy", "summary": "Retrieve the Power Hierarchy", "description": "This endpoint returns the power hierarchy and provides data for invoking other APIs such as Power APIs that require power hierarchy information.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Hierarchy APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": false, "schema": { "type": "string", "description": "IBX Code" } } ], "result": { "name": "smartview_getPowerHierarchyResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/PowerHierarchyNode" }, "x-fastmcp-top-level-schema": "PowerResponse" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Retrieve the Power Hierarchy", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getSensorReadings", "summary": "Retrieve IBX sensors current readings", "description": "Returns current environmental (temperature and humidity) sensor readings for the given IBX code in a paginated way.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Environment APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "ibx", "description": "IBX where the sensor is located.", "required": true, "schema": { "type": "string", "example": "CH2", "description": "IBX where the sensor is located." } }, { "name": "type", "description": "Type of sensor data to display, e.g. specifying 'HUMIDITY' means only sensor readings with HUMIDITY value will be included", "required": false, "schema": { "type": "string", "example": "HUMIDITY", "description": "Type of sensor data to display, e.g. specifying 'HUMIDITY' means only sensor readings with HUMIDITY value will be included" } }, { "name": "zone", "description": "Zone name. Adding this parameter limits the query to sensors in the specified zone", "required": false, "schema": { "type": "string", "example": "CH2:1:06:ColoArea:1", "description": "Zone name. Adding this parameter limits the query to sensors in the specified zone" } }, { "name": "offset", "description": "Results offset you want to retrieve (0..N)", "required": false, "schema": { "type": "integer", "default": 0, "description": "Results offset you want to retrieve (0..N)" } }, { "name": "limit", "description": "Number of records to retrieve per request.", "required": false, "schema": { "type": "integer", "default": 20, "description": "Number of records to retrieve per request." } } ], "result": { "name": "smartview_getSensorReadingsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "ibx", "sensorId", "zoneId" ], "type": "object", "properties": { "sensorId": { "type": "string", "description": "The sensor identifier.", "example": "SV2.Environmental.Colo4-ZoneHumidity1" }, "zoneId": { "type": "string", "description": "The zone where the sensor is placed.", "example": "CH2:1:06:ColoArea:1" }, "ibx": { "type": "string", "description": "The ibx identifier where the sensor is placed.", "example": "SV2" }, "humidity": { "$ref": "#/components/schemas/Humidity_c93621ed" }, "temperature": { "$ref": "#/components/schemas/Temperature" } }, "description": "Single environmental sensor reading." }, "description": "List of data objects" }, "pagination": { "$ref": "#/components/schemas/Pagination_25a0752b" } }, "x-fastmcp-top-level-schema": "SensorReadingsResponse" } }, "x-mcp-annotations": { "title": "Retrieve IBX sensors current readings", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getSingleSensorReadings", "summary": "Retrieve Single sensor current value(s)", "description": "Returns current environmental sensor readings such as temperature and humidity for the given sensor ID and IBX code.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Environment APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "ibx", "description": "IBX where the sensor is located.", "required": true, "schema": { "type": "string", "example": "SV2", "description": "IBX where the sensor is located." } }, { "name": "sensorId", "description": "Id of sensor to read.", "required": true, "schema": { "type": "string", "example": "CH2.Environmental.MbusColo3Mod5.MOD35.C3TS03", "description": "Id of sensor to read." } } ], "result": { "name": "smartview_getSingleSensorReadingsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "required": [ "ibx", "sensorId", "zoneId" ], "type": "object", "properties": { "sensorId": { "type": "string", "description": "The sensor identifier.", "example": "SV2.Environmental.Colo4-ZoneHumidity1" }, "zoneId": { "type": "string", "description": "The zone where the sensor is placed.", "example": "CH2:1:06:ColoArea:1" }, "ibx": { "type": "string", "description": "The ibx identifier where the sensor is placed.", "example": "SV2" }, "humidity": { "$ref": "#/components/schemas/Humidity_c93621ed" }, "temperature": { "$ref": "#/components/schemas/Temperature" } }, "description": "Single environmental sensor reading.", "x-fastmcp-top-level-schema": "SensorReading" } }, "x-mcp-annotations": { "title": "Retrieve Single sensor current value(s)", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getSubscriptionById", "summary": "Retrieve subscription by ID", "description": "This endpoint allows users to fetch details for a given streaming subscription for a given organization.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Streaming Subscription API" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "id", "required": true, "schema": { "type": "string" } } ], "result": { "name": "smartview_getSubscriptionByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "enum": [ "PENDING", "ACTIVE", "FAILED", "DELETE_IN_PROGRESS", "DELETED" ], "type": "string" }, "messageType": { "$ref": "#/components/schemas/MessageType" }, "channel": { "$ref": "#/components/schemas/Channel" }, "orgId": { "type": "string" }, "createdBy": { "type": "string" }, "createdDateTime": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "updatedDateTime": { "type": "string", "format": "date-time" } }, "description": "Subscription Response", "x-fastmcp-top-level-schema": "SubscriptionResponse" } }, "x-mcp-annotations": { "title": "Retrieve subscription by ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getSubscriptionData", "summary": "Retrieve subscription data via REST", "description": "This endpoint allows users to obtain API+ near real time data via a simple REST endpoint by employing subscription ID alongside other specified criteria, enabling a comprehensive and targeted approach to data retrieval. Subscription data endpoint works for all channels and not just REST channel.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Streaming Subscription API" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "subscriptionId", "description": "Subscription ID", "required": true, "schema": { "type": "string", "description": "Subscription ID" } }, { "name": "ibxs", "description": "Filter, set of IBXs", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter, set of IBXs" } }, { "name": "messageTypes", "description": "Filter, set of message types", "required": false, "schema": { "type": "array", "items": { "enum": [ "ALARM", "ALERT", "ENVIRONMENTAL", "METERED_POWER", "POWER", "TAG_POINT" ], "type": "string" }, "description": "Filter, set of message types" } }, { "name": "streamIds", "description": "Filter, set of stream IDs", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter, set of stream IDs" } }, { "name": "offset", "description": "Pagination, offset of the first item", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "description": "Pagination, offset of the first item" } }, { "name": "limit", "description": "Pagination, limit of items returned", "required": false, "schema": { "type": "integer", "format": "int32", "default": 250, "description": "Pagination, limit of items returned" } } ], "result": { "name": "smartview_getSubscriptionDataResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "alarmMessageData": { "type": "array", "items": { "required": [ "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "message type", "default": "system-alert", "example": "system-alert" }, "data": { "required": [ "asset", "currentValue", "definitionId", "ibx", "status", "streamId", "tag", "threshold" ], "type": "object", "properties": { "streamId": { "type": "string", "description": "unique message id", "example": "IBX.CRAH-EQ1-04:dirtyfilter#ABSOLUTE:HIGH" }, "ibx": { "type": "string", "description": "ibx", "example": "IBX" }, "region": { "type": "string", "description": "region", "example": "EMEA" }, "metro": { "type": "string", "description": "metro", "example": "metro" }, "country": { "type": "string", "description": "country", "example": "FR" }, "conditionName": { "type": "string", "description": "condition name", "example": "High" }, "severity": { "type": "integer", "description": "severity", "format": "int32", "example": 900 }, "type": { "type": "string", "description": "type", "example": "Absolute" }, "heartbeat": { "type": "boolean", "description": "heartbeat", "example": true }, "triggerRule": { "type": "string", "description": "trigger rule", "example": "RULE:123:1" }, "definitionId": { "type": "string", "description": "unique message id", "example": "IBX.CRAH-EQ1-04:dirtyfilter#ABSOLUTE:HIGH" }, "currentValue": { "type": "object", "properties": { "unit": { "type": "string", "description": "current value unit", "example": "%" }, "value": { "type": "string", "description": "current value value", "example": "35.023" }, "type": { "type": "string", "description": "current value type", "example": "Float" } }, "description": "currentValue details" }, "asset": { "type": "object", "properties": { "id": { "type": "string", "description": "asset id", "example": "IBX.CRAH-EQ1-04" }, "type": { "type": "string", "description": "asset type", "example": "CRAH" }, "classification": { "type": "string", "description": "asset classification", "example": "Mechanical" } }, "description": "asset details" }, "tag": { "type": "object", "properties": { "id": { "type": "string", "description": "tag id", "example": "IBX.CRAH-EQ1-04:dirtyfilter" }, "displayName": { "type": "string", "description": "tag display name", "example": "Temperature7" } }, "description": "tag details" }, "status": { "type": "object", "properties": { "acknowledged": { "type": "boolean", "description": "status acknowledged", "example": false }, "acknowledgementTime": { "type": "string", "description": "status acknowledgement time", "example": "2023-10-03T13:09:32" }, "cleared": { "type": "boolean", "description": "status cleared", "example": false }, "active": { "type": "boolean", "description": "status active", "example": true } }, "description": "status details" }, "threshold": { "type": "object", "properties": { "unit": { "type": "string", "description": "threshold unit", "example": "%" }, "stateLimit": { "type": "string", "description": "threshold state limit", "example": "20" }, "message": { "type": "string", "description": "threshold message", "example": "NA" } }, "description": "threshold details" }, "triggeredTime": { "type": "string", "description": "alarm triggered time", "example": "2023-10-03T13:09:32" }, "processedTime": { "type": "string", "description": "alarm processed time", "example": "2023-10-03T13:09:32" }, "normalProcessedTime": { "type": "string", "description": "alarm normal processed time", "example": "2023-10-03T13:09:32" }, "normalTriggeredTime": { "type": "string", "description": "alarm normal triggered time", "example": "2023-10-03T13:09:32" }, "dataQuality": { "type": "string", "description": "data quality - Good | Bad | Uncertain", "example": "Good" } }, "description": "message data" } }, "description": "alarm message data" }, "description": "alarm message data" }, "alertMessageData": { "type": "array", "items": { "required": [ "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "message type", "default": "custom-alert", "example": "custom-alert" }, "data": { "required": [ "asset", "ibx", "streamId", "tag", "threshold" ], "type": "object", "properties": { "streamId": { "type": "string", "description": "unique message id", "example": "IBX.685306-15843739015670.6640131967865078" }, "ibx": { "type": "string", "description": "ibx", "example": "IBX" }, "region": { "type": "string", "description": "region", "example": "APAC" }, "id": { "type": "string", "description": "id", "example": "IBX.685306-15843739015670.6640131967865078" }, "type": { "type": "string", "description": "type", "example": "power" }, "typeId": { "type": "string", "description": "type id", "example": "drawAmpFalls" }, "conditional": { "type": "string", "description": "conditional", "example": "N" }, "eventType": { "type": "string", "description": "event type", "example": "Falls below" }, "heartbeat": { "type": "boolean", "description": "heartbeat", "example": true }, "asset": { "type": "object", "properties": { "id": { "type": "string", "description": "asset id", "example": "1.20849261E7" }, "type": { "type": "string", "description": "asset type", "example": "CIRCUIT" }, "classification": { "type": "string", "description": "asset classification", "example": "Electrical" } }, "description": "asset details" }, "tag": { "type": "object", "properties": { "id": { "type": "string", "description": "tag id", "example": "IBX.CIRCUIT-EQ1-04:dirtyfilter" } }, "description": "tag details" }, "threshold": { "type": "object", "properties": { "unit": { "type": "string", "description": "threshold unit", "example": "Amp" }, "maxValue": { "type": "string", "description": "threshold max value", "example": "5" }, "minValue": { "type": "string", "description": "threshold min value", "example": "1" }, "value": { "type": "string", "description": "threshold value", "example": "10" } }, "description": "threshold details" }, "triggeredTime": { "type": "string", "description": "alert triggered time", "example": "2023-10-03T13:09:32" }, "dataQuality": { "type": "string", "description": "data quality - Good | Bad | Uncertain", "example": "Good" } }, "description": "message data" } }, "description": "alert message data" }, "description": "alert message data" }, "environmentMessageData": { "type": "array", "items": { "required": [ "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "message type", "default": "environmental", "example": "environmental" }, "data": { "required": [ "asset", "ibx", "reading", "streamId", "tag" ], "type": "object", "properties": { "streamId": { "type": "string", "description": "unique message id", "example": "IBX.IBX:humidity" }, "ibx": { "type": "string", "description": "ibx", "example": "IBX" }, "asset": { "required": [ "id", "level" ], "type": "object", "properties": { "id": { "type": "string", "description": "asset id", "example": "IBX" }, "level": { "type": "string", "description": "asset level", "example": "IBX" } }, "description": "asset details" }, "reading": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "Environmental reading value", "example": "50.045" }, "unit": { "type": "string", "description": "Environmental reading unit", "example": "PERCENT" } }, "description": "reading details" }, "tag": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "tag id", "example": "humidity" }, "displayName": { "type": "string", "description": "tag display name", "example": "Humidity" } }, "description": "tag details" }, "readingTime": { "type": "string", "description": "message reading time", "example": "2023-10-03T13:09:32" }, "dataQuality": { "type": "string", "description": "data quality - Good | Bad | Uncertain", "example": "Good" } }, "description": "message data" } }, "description": "environment message data" }, "description": "environment message data" }, "meteredPowerMessageData": { "type": "array", "items": { "required": [ "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "message type", "default": "metered-power", "example": "metered-power" }, "data": { "$ref": "#/components/schemas/MeteredPowerItem" } }, "description": "metered-power message data" }, "description": "metered-power message data" }, "powerMessageData": { "type": "array", "items": { "required": [ "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "message type", "default": "power", "example": "power" }, "data": { "required": [ "asset", "ibx", "streamId" ], "type": "object", "properties": { "streamId": { "type": "string", "description": "unique message id", "example": "IBX:140838" }, "ibx": { "type": "string", "description": "ibx", "example": "IBX" }, "asset": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "asset id", "example": "IBX:140838" }, "type": { "type": "string", "description": "asset type", "example": "CIRCUIT" } }, "description": "asset details" }, "cage": { "type": "string", "description": "cage", "example": "IBX:02:021305" }, "cabinet": { "type": "string", "description": "cabinet", "example": "IBX:01:000Z4Z:0102" }, "accountNumber": { "type": "string", "description": "account number", "example": "123456" }, "description": { "type": "string", "description": "description", "example": "32-amp 230v Single Phase Primary AC Power" }, "oid": { "type": "string", "description": "oid", "example": "1.3.6.1.2.1.299.36.10.1099" }, "circuitType": { "type": "string", "description": "circuit type", "example": "PRIMARY" }, "realPower": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "RealPower reading value", "example": "0.0" }, "unit": { "type": "string", "description": "RealPower reading unit", "example": "kW" } }, "description": "realPower details" }, "apparentPower": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "ApparentPower reading value", "example": "7.36" }, "unit": { "type": "string", "description": "ApparentPower reading unit", "example": "kVA" } }, "description": "apparentPower details" }, "contractualPower": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "ContractualPower reading value", "example": "0.0" }, "unit": { "type": "string", "description": "ContractualPower reading unit", "example": "kVA" } }, "description": "contractualPower details" }, "current": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "Current reading value", "example": "7.36" }, "unit": { "type": "string", "description": "Current reading unit", "example": "A" } }, "description": "current details" }, "powerFactor": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "PowerFactor reading value", "example": "0.0" }, "unit": { "type": "string", "description": "PowerFactor reading unit", "example": "pf" } }, "description": "powerFactor details" }, "soldCurrent": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "SoldCurrent reading value", "example": "7.36" }, "unit": { "type": "string", "description": "SoldCurrent reading unit", "example": "A" } }, "description": "soldCurrent details" }, "soldPower": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "SoldPower reading value", "example": "68.125" }, "unit": { "type": "string", "description": "SoldPower reading unit", "example": "kVA" } }, "description": "soldPower details" }, "powerConsumptionToContractual": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "PowerConsumptionToContractual reading value", "example": "68.125" }, "unit": { "type": "string", "description": "PowerConsumptionToContractual reading unit", "example": "PERCENT" } }, "description": "powerConsumptionToContractual details" }, "cabinetRating": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "CabinetRating reading value", "example": "8.125" }, "unit": { "type": "string", "description": "CabinetRating reading unit", "example": "kVA" } }, "description": "cabinetRating details" }, "peakLastSevenDays": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "PeakLastSevenDays reading value", "example": "7.36" }, "unit": { "type": "string", "description": "PeakLastSevenDays reading unit", "example": "kVA" } }, "description": "peakLastSevenDays details" }, "peakLastSevenDaysRatio": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "PeakLastSevenDaysRatio reading value", "example": "48.125" }, "unit": { "type": "string", "description": "PeakLastSevenDaysRatio reading unit", "example": "PERCENT" } }, "description": "peakLastSevenDaysRatio details" }, "peakLastSevenDaysContractualPower": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "PeakLastSevenDaysContractualPower reading value", "example": "0.0" }, "unit": { "type": "string", "description": "PeakLastSevenDaysContractualPower reading unit", "example": "kVA" } }, "description": "peakLastSevenDaysContractualPower details" }, "peakLastSevenDaysTime": { "type": "string", "description": "peak last seven days time", "example": "2023-10-03T13:09:32" }, "lastUpdated": { "type": "string", "description": "last updated time", "example": "2023-10-03T13:09:32" }, "readingTime": { "type": "string", "description": "message reading time", "example": "2023-10-03T13:09:32" } }, "description": "message data" } }, "description": "power message data" }, "description": "power message data" }, "tagPointMessageData": { "type": "array", "items": { "required": [ "data", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "message type", "default": "tag-point", "example": "tag-point" }, "data": { "required": [ "dataQuality", "ibx", "reading", "readingTime", "streamId", "tag" ], "type": "object", "properties": { "streamId": { "type": "string", "description": "unique message id", "example": "IBX.ATS-M1-04:outputvoltageca" }, "ibx": { "type": "string", "description": "ibx", "example": "IBX" }, "tag": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "tag id", "example": "IBX.ATS-M1-04:outputvoltageca" }, "displayName": { "type": "string", "description": "tag display name", "example": "Output Voltage CA" } }, "description": "tag details" }, "reading": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "reading value", "example": "50.045" }, "unit": { "type": "string", "description": "reading unit", "example": "V" } }, "description": "reading details" }, "readingTime": { "type": "string", "description": "message reading time", "example": "2023-10-03T13:09:32" }, "dataQuality": { "type": "string", "description": "data quality - Good | Bad | Uncertain", "example": "Good" } }, "description": "message data" } }, "description": "tag-point message data" }, "description": "tag-point message data" }, "pagination": { "$ref": "#/components/schemas/Pagination_25a0752b" } }, "x-fastmcp-top-level-schema": "SubscriptionData" } }, "x-mcp-annotations": { "title": "Retrieve subscription data via REST", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getTrendingEnvironmentData", "summary": "Retrieve trending environmental data", "description": "The API returns trending environment information (temperature and humidity) for input ibx, zone, cage, sensor.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Environment APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": true, "schema": { "type": "string", "description": "IBX Code" } }, { "name": "dataPoint", "description": "Data point", "required": true, "schema": { "enum": [ "temperature", "humidity" ], "type": "string", "description": "Data point" } }, { "name": "levelType", "description": "Level Type", "required": true, "schema": { "enum": [ "IBX", "ZONE", "CAGE", "SENSOR" ], "type": "string", "description": "Level Type" } }, { "name": "levelValue", "description": "Level Value is ibxCode, zone, cage, sensorid for levelType ibx, zone, cage, sensor resp.", "required": true, "schema": { "type": "string", "description": "Level Value is ibxCode, zone, cage, sensorid for levelType ibx, zone, cage, sensor resp." } }, { "name": "interval", "description": "Interval", "required": true, "schema": { "enum": [ "reading", "1h", "1d" ], "type": "string", "description": "Interval" } }, { "name": "fromDate", "description": "Date in long", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Date in long" } }, { "name": "toDate", "description": "Date in long", "required": true, "schema": { "type": "string", "format": "date-time", "description": "Date in long" } } ], "result": { "name": "smartview_getTrendingEnvironmentDataResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "ibx": { "type": "string", "description": "ibx code", "example": "CH1" }, "accountNo": { "type": "string", "description": "customer account num", "example": "1" }, "interval": { "type": "string", "description": "interval", "example": "reading" }, "datapoint": { "type": "string", "description": "data point for which the timeseries data is fetched", "example": "temperature" }, "uom": { "type": "string", "description": "unit of measure used for the datapoint", "example": "°C" }, "series": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "reading value for the datapoint", "example": "21.11" }, "modifiers": { "type": "array", "items": { "type": "string", "example": "recorded" }, "description": "modifiers applicable for the reading value" }, "datetime": { "type": [ "string", "null" ], "format": "date-time", "x-equinix-format": "epoch-millis", "x-example": "1483228800000" } }, "description": "This object contains a single reading for the data point." }, "description": "Time series data for the data point" } } } }, "x-fastmcp-top-level-schema": "TrendingEnvironmentData" } }, "x-mcp-annotations": { "title": "Retrieve trending environmental data", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_getTrendingPowerData", "summary": "Retrieve Trending Power Data.", "description": "This trending power data for draw kVA to max allowed (%) for input ibx, cage, cabinet, circuit.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "DCIM Power APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": true, "schema": { "type": "string", "description": "IBX Code" } }, { "name": "levelType", "description": "[ibx|cage|cabinet|circuit]", "required": true, "schema": { "enum": [ "ibx", "cage", "cabinet", "circuit" ], "type": "string", "description": "[ibx|cage|cabinet|circuit]" } }, { "name": "levelValue", "description": "ibx code, cage unique space id, cabinet unique space id and serial number for level type ibx, cage, cabinet and circuit respectively.", "required": true, "schema": { "type": "string", "description": "ibx code, cage unique space id, cabinet unique space id and serial number for level type ibx, cage, cabinet and circuit respectively." } }, { "name": "interval", "description": "[recording|1h|1d]", "required": true, "schema": { "type": "string", "description": "[recording|1h|1d]" } }, { "name": "fromDate", "description": "timestamp expected to be epoch long (milliseconds).", "required": true, "schema": { "type": "string", "description": "timestamp expected to be epoch long (milliseconds)." } }, { "name": "toDate", "description": "timestamp expected to be epoch long (milliseconds).", "required": true, "schema": { "type": "string", "description": "timestamp expected to be epoch long (milliseconds)." } } ], "result": { "name": "smartview_getTrendingPowerDataResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "accountNumber": { "type": "string", "example": "123456" }, "ibx": { "type": "string", "example": "ABX" }, "levelType": { "enum": [ "ibx", "cage", "cabinet", "circuit" ], "type": "string", "description": "power hierarchy node levelType linked to the power data" }, "levelValue": { "type": "string", "description": "ibx code, cage unique space id, cabinet unique space id and serial number for levelType ibx, cage, cabinet, circuit resp.", "example": "ABX" }, "interval": { "enum": [ "5m", "15m", "1h", "1d" ], "type": "string", "description": "serial number", "example": "1h" }, "data": { "type": "array", "items": { "type": "object", "properties": { "datetime": { "type": [ "string", "null" ], "format": "date-time", "x-equinix-format": "epoch-millis", "x-example": "1483228800000" }, "value": { "type": "string", "description": "trending values", "example": "0.147" } }, "description": "date and corresponding values" } } } }, "status": { "type": "object", "properties": { "type": { "enum": [ "INFO" ], "type": "string", "description": "[INFO|ERROR] are the possible values" }, "statuscode": { "type": "number", "description": "[1000|3001|3002|3003|4000] are the possible status codes", "example": 1000 }, "msg": { "type": "string", "description": "[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|From/ToDate interval cannot be greater than 1 year|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages", "example": "OK" } } } }, "x-fastmcp-top-level-schema": "TrendingPowerData" } }, "x-mcp-annotations": { "title": "Retrieve Trending Power Data.", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_listCurrentEnvironmentData", "summary": "Retrieve a list of environmental data", "description": "The API returns environment info (humidity and temperature) for all the values for input level type IBX, ZONE, CAGE, SENSOR.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Environment APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": true, "schema": { "type": "string", "description": "IBX Code" } }, { "name": "levelType", "description": "Level Type", "required": true, "schema": { "enum": [ "IBX", "ZONE", "CAGE", "SENSOR" ], "type": "string", "description": "Level Type" } } ], "result": { "name": "smartview_listCurrentEnvironmentDataResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "total number of data values", "example": 1 }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PayLoad_90f61cdf" } } } }, "status": { "$ref": "#/components/schemas/Status_ae81556b" } }, "x-fastmcp-top-level-schema": "EnvironmentDataResponse" } }, "x-mcp-annotations": { "title": "Retrieve a list of environmental data", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_pauseAlertConfiguration", "summary": "Pause a power alert configuration", "description": "Pauses an active power alert configuration. When paused, the configuration will not\ntrigger any new power event alerts until it is resumed. The configuration remains\naccessible and can be resumed at any time.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Power Events" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "alertConfigurationUid", "description": "Unique identifier (UUID) of the power alert configuration to pause", "required": true, "schema": { "type": "string", "example": "9756a585-c3c1-4648-b2e1-7d8804912098", "description": "Unique identifier (UUID) of the power alert configuration to pause" } } ], "result": { "name": "smartview_pauseAlertConfigurationResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Pause a power alert configuration", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_postAlerts", "summary": "System alerts search", "description": "This endpoint returns all system alerts in a paginated way\nallows narrowing returned results by submitting additional search filters.\n\nAllowed search filters.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "DCIM System Alert" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "limit", "description": "Number of records to retrieve per request.", "required": true, "schema": { "type": "integer", "example": 100, "description": "Number of records to retrieve per request." } }, { "name": "offset", "description": "Record Number you want start to retrieve from (0..N)", "required": true, "schema": { "type": "integer", "example": 0, "description": "Record Number you want start to retrieve from (0..N)" } }, { "name": "status", "description": "Alert status - ACTIVE or INACTIVE", "required": false, "schema": { "type": "string", "example": "ACTIVE", "description": "Alert status - ACTIVE or INACTIVE" } }, { "name": "assetClassification", "description": "The class of assets this asset belongs to - Mechanical/Electrical/Environmental", "required": false, "schema": { "type": "string", "example": "Mechanical", "description": "The class of assets this asset belongs to - Mechanical/Electrical/Environmental" } }, { "name": "edgeCollectedOn", "description": "Returns the alarms after the passed time", "required": false, "schema": { "type": "string", "example": "2023-11-30T05:08:39.345000Z", "description": "Returns the alarms after the passed time" } } ], "result": { "name": "smartview_postAlertsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Smartview_getAlertsResult" } }, "x-mcp-annotations": { "title": "System alerts search", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_postAssetDetails", "summary": "Retrieve asset details", "description": "This endpoint returns information about assets details including the assets tag points list for the given multiple asset identifiers.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Assets APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "customer account number", "required": false, "schema": { "type": "string", "description": "customer account number" } }, { "name": "ibx", "description": "ibx code", "required": false, "schema": { "type": "string", "description": "ibx code" } }, { "name": "classification", "description": "asset classification", "required": false, "schema": { "type": "string", "description": "asset classification" } }, { "name": "assetIds", "required": false, "schema": { "type": "array", "items": { "type": "string", "description": "asset id" } } } ], "result": { "name": "smartview_postAssetDetailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "total number of assets that match the request filters", "example": 1 }, "assetDetails": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "string", "description": "asset id for the Asset", "example": "CH1.Chiller-1" }, "assetType": { "type": "string", "description": "Template Name for the asset", "example": "Cooling" }, "userPrefTimeZone": { "type": "string", "description": "Time zone for the user", "example": "Asia/Katmandu" }, "tags": { "$ref": "#/components/schemas/Tags_b7839971" }, "lastMaintenanceDate": { "type": "string", "description": "Datetime when the machine had its last maintenance", "format": "date-time", "example": "2020-06-11T17:11:19" }, "manufacturerName": { "type": "string", "description": "Manufacturer name for the Asset", "example": "SMARDT" }, "equipmentModelNumber": { "type": "string", "description": "Equipment Model Number", "example": "SACAC110-3EXX-2A1-16A-010" }, "equipmentSerialNumber": { "type": "string", "description": "Equipment Serial Number", "example": "FF0010I233Q1276" }, "alarmLastTriggeredTime": { "type": "string", "description": "Datetime when the latest alarm was triggered on the asset", "example": "Aug 21,2017 04:38 AM" }, "alarmLastProcessedTime": { "type": "string", "description": "Datetime when the latest alarm was processed on the asset", "example": "Aug 21,2017 05:52 AM" } }, "description": "Asset Details includes Tag Points with Data for the asset" } } } }, "status": { "$ref": "#/components/schemas/Status_362bd37d" } }, "description": "response object for asset/details POST request", "x-fastmcp-top-level-schema": "AssetDetailsResponse" } }, "x-mcp-annotations": { "title": "Retrieve asset details", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smartview_postCurrentPowerData", "summary": "Retrieve current power consumption data", "description": "This powerdata endpoint returns power consumption info for all values of input level type ibx, cage, cabinet or circuit.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "DCIM Power APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": false, "schema": { "type": "string", "description": "Customer Account Number", "example": "1234" } }, { "name": "ibx", "description": "trending values", "required": false, "schema": { "type": "string", "description": "trending values", "example": "0.147" } }, { "name": "levelType", "description": "level type allowed value [ibx|cage|cabinet|circuit]", "required": false, "schema": { "enum": [ "ibx", "cage", "cabinet", "circuit" ], "type": "string", "description": "level type allowed value [ibx|cage|cabinet|circuit]", "example": "ibx" } } ], "result": { "name": "smartview_postCurrentPowerDataResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "ibx": { "type": "string", "description": "ibx code", "example": "ABC" }, "accountNo": { "type": "string", "description": "customer account number", "example": "ABC" }, "levelType": { "enum": [ "ibx", "cage", "cabinet", "circuit" ], "type": "string", "description": "power hierarchy node levelType linked to the power data", "example": "ibx" }, "levelValue": { "type": "string", "description": "power hierarchy node levelValue linked to the power data", "example": "ABC" }, "isAlarm": { "type": "string", "description": "returns boolean based on breakertip alarm", "example": "true" }, "kva": { "type": "number", "description": "power consumption in kva", "example": 54.402 }, "amps": { "type": "number", "description": "instantaneous current amp reading on circuits", "example": 123 }, "soldKva": { "type": "number", "description": "maximum amp draw allowable on a circuit", "example": 598.349 }, "cabinetRating": { "type": "number", "description": "maximum kVA draw allowed for the cabinet", "example": 123 }, "contractualKva": { "type": "number", "description": "The maximum power draw contractually allowable in a private cage. example - 341.54" }, "percentageKva": { "type": "number", "description": "calculated field kva / contractualKva", "example": 15.928 }, "comparisonData": { "$ref": "#/components/schemas/ComparisonData" }, "peakKvaLastSevenDays": { "type": "number", "example": 55.296 }, "peakKvaLastSevenDaysPercentage": { "type": "number", "example": 55.296 }, "peakKvaLastSevenDaysContractualKva": { "type": "number", "example": 55.296 }, "peakKvaLastSevenDaysTime": { "type": "integer", "example": 55 }, "soldAmps": { "type": "integer", "description": "circuit description when the levelType is circuit. Null otherwise.", "example": 123 }, "primaryKva": { "type": "number", "description": "the sum of instantaneous power draw reading on all the primary circuits within the levelType.", "example": 28.31 }, "redundantKva": { "type": "number", "description": "the sum of instantaneous power draw reading on all the redundant circuits within the levelType.", "example": 26.092 }, "kw": { "type": "string", "description": "measure of real power expressed in kilowatt applicable for ibxs that have capability of energy meter reading|value will be \"NA\" for AMER and APAC regions", "example": "NA" }, "powerFactor": { "type": "string", "description": "The ratio between real power and apparent power in a circuit.(kW/kVA)|value will be \"NA\" for AMER and APAC regions", "example": "NA" }, "readingTime": { "type": "string", "description": "date-time when the latest value was read in (epoc - milliseconds).", "example": "1497410400000" }, "lastUpdatedTime": { "type": "string", "description": "date-time when the latest value was updated (epoc - milliseconds).", "example": "1497410520000" }, "customerName": { "type": "string", "example": "ABC" } } } } } }, "status": { "$ref": "#/components/schemas/Status_362bd37d" } }, "x-fastmcp-top-level-schema": "PowerDataResponse_IBX" } }, "x-mcp-annotations": { "title": "Retrieve current power consumption data", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smartview_postCurrentTagPoint", "summary": "Retrieve current tag points data", "description": "This endpoint fetches the latest read values for given tag points using given tag identifiers.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Assets APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "customer account number", "required": false, "schema": { "type": "string", "description": "customer account number" } }, { "name": "tagIds", "required": false, "schema": { "maxLength": 1000, "type": "array", "items": { "type": "string", "description": "tag ids" } } }, { "name": "ibx", "description": "ibx code", "required": false, "schema": { "type": "string", "description": "ibx code" } } ], "result": { "name": "smartview_postCurrentTagPointResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Smartview_getCurrentTagPointResult" } }, "x-mcp-annotations": { "title": "Retrieve current tag points data", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "smartview_resumeAlertConfiguration", "summary": "Resume a power alert configuration", "description": "Resumes a previously paused power alert configuration, returning it to ACTIVE state.\nOnce resumed, the configuration will begin triggering alerts again when its defined\nconditions are met.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Power Events" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "alertConfigurationUid", "description": "Unique identifier (UUID) of the power alert configuration to resume", "required": true, "schema": { "type": "string", "example": "9756a585-c3c1-4648-b2e1-7d8804912098", "description": "Unique identifier (UUID) of the power alert configuration to resume" } } ], "result": { "name": "smartview_resumeAlertConfigurationResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Resume a power alert configuration", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_searchAlertConfigurations", "summary": "Search power alert configurations", "description": "Returns a paginated list of power alert configurations matching the specified filters.\nResults can be filtered by IBX and state. Both `limit` and `offset` are required to control pagination.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Power Events" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "limit", "description": "Number of records to retrieve per request", "required": true, "schema": { "type": "integer", "example": 100, "description": "Number of records to retrieve per request" } }, { "name": "offset", "description": "Record number to start retrieval from (0..N)", "required": true, "schema": { "type": "integer", "example": 0, "description": "Record number to start retrieval from (0..N)" } }, { "name": "ibx", "description": "List of IBX codes to filter configurations (comma-separated)", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "example": [ "SV5", "NY1" ], "description": "List of IBX codes to filter configurations (comma-separated)" } }, { "name": "state", "description": "List of states to filter configurations (comma-separated). Possible values - ACTIVE, PAUSED, DELETED", "required": false, "schema": { "type": "array", "items": { "enum": [ "ACTIVE", "PAUSED", "DELETED" ], "type": "string" }, "example": [ "ACTIVE" ], "description": "List of states to filter configurations (comma-separated). Possible values - ACTIVE, PAUSED, DELETED" } } ], "result": { "name": "smartview_searchAlertConfigurationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "alertConfigurationUid": { "type": "string", "description": "Unique identifier of the alert configuration", "format": "uuid", "example": "9756a585-c3c1-4648-b2e1-7d8804912098" }, "ibx": { "type": "string", "description": "IBX code associated with the alert configuration", "example": "SV5" }, "state": { "enum": [ "ACTIVE", "PAUSED", "DELETED" ], "type": "string", "description": "Current state of the alert configuration", "example": "ACTIVE" }, "section": { "type": "string", "description": "Section type of the alert configuration", "example": "POWER" }, "source": { "type": "string", "description": "Source system that created the configuration", "example": "API" }, "condition": { "$ref": "#/components/schemas/Condition" }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientsItem" }, "description": "List of configured notification recipients" }, "creator": { "type": "object", "properties": { "accountNo": { "type": "string", "description": "Account number of the creator", "example": "123456" }, "ucmId": { "type": [ "string", "null" ], "description": "UCM ID of the creator" }, "accountName": { "type": "string", "description": "Account name of the creator", "example": "Acme Corp" }, "userKey": { "type": "string", "description": "User key of the creator", "example": "jdoe" }, "email": { "type": "string", "description": "Email address of the creator", "example": "jdoe@example.com" } }, "description": "Information about the user who created the configuration" }, "createdOn": { "type": "string", "description": "Timestamp when the configuration was created", "format": "date-time", "example": "2024-01-10T12:00:00.000Z" }, "updatedOn": { "type": [ "string", "null" ], "description": "Timestamp when the configuration was last updated", "format": "date-time", "example": "2024-01-15T09:30:00.000Z" }, "assets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Assets_74bfea69" }, "description": "Assets being monitored, keyed by level type (CAGE, CABINET, CIRCUIT)" } }, "description": "Represents a single power alert configuration" }, "description": "Array of power alert configurations" }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "description": "Starting record index for this page", "example": 0 }, "limit": { "type": "integer", "description": "Number of records returned per request", "example": 100 }, "total": { "type": "integer", "description": "Total number of records matching the query", "example": 15 } }, "description": "Pagination metadata" } }, "description": "Paginated response containing a list of power alert configurations", "x-fastmcp-top-level-schema": "AlertPaginatedResponse" } }, "x-mcp-annotations": { "title": "Search power alert configurations", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_searchAsset", "summary": "Search for Assets matching the identifiers", "description": "This endpoint is used to search for assets using wild card search patterns matching the asset identifier.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "SmartView Assets APIs" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "accountNo", "description": "Customer Account Number", "required": true, "schema": { "type": "string", "description": "Customer Account Number" } }, { "name": "ibx", "description": "IBX Code", "required": true, "schema": { "type": "string", "description": "IBX Code" } }, { "name": "searchString", "description": "Search String", "required": true, "schema": { "type": "string", "description": "Search String" } } ], "result": { "name": "smartview_searchAssetResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "payLoad": { "type": "object", "properties": { "totalCount": { "type": "integer", "example": 1 }, "assetsList": { "type": "array", "items": { "type": "object", "properties": { "assetId": { "type": "string", "description": "The assetid is the circuit number, sensor id, asset id, asset id for type circuit, sensor, electrical and mechanical resp.", "example": "CH1.ASTS-1-2-A" }, "type": { "type": "string", "example": "ASTS" }, "assetLabel": { "type": "string", "description": "Asset Label is the Circuit display label, Sensor ID, and Asset ID for types circuit, sensor, electrical and mechanical resp.", "example": "CH1.ASTS-1-2-A" }, "assetClassification": { "type": "string", "description": "Asset classification is electrical or mechanical", "example": "Electrical" } } } } } }, "status": { "$ref": "#/components/schemas/Status_0819e0b5" } }, "x-fastmcp-top-level-schema": "Assets" } }, "x-mcp-annotations": { "title": "Search for Assets matching the identifiers", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_updatePowerAlertConfiguration", "summary": "Update a power alert configuration", "description": "Updates an existing power alert configuration identified by its `alertConfigurationUid`.\nYou can update the condition, threshold, recipients, and assets associated with the configuration.\nYou can also change the state of the configuration to ACTIVE, PAUSED, or DELETED.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Power Events" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "alertConfigurationUid", "description": "Unique identifier of the power alert configuration to update", "required": true, "schema": { "type": "string", "description": "Unique identifier of the power alert configuration to update", "format": "uuid", "example": "9756a585-c3c1-4648-b2e1-7d8804912098" } }, { "name": "state", "description": "New state for the configuration", "required": false, "schema": { "enum": [ "ACTIVE", "PAUSED", "DELETED" ], "type": "string", "description": "New state for the configuration", "example": "ACTIVE" } }, { "name": "condition", "description": "Defines the condition that triggers a power alert", "required": false, "schema": { "$ref": "#/components/schemas/Condition" } }, { "name": "recipients", "description": "Updated list of recipients", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientsItem" }, "description": "Updated list of recipients" } }, { "name": "assets", "description": "Updated assets to monitor, scoped by level type (CAGE, CABINET, CIRCUIT)", "required": false, "schema": { "type": "object", "properties": { "CAGE": { "$ref": "#/components/schemas/Assets_74bfea69" }, "CABINET": { "$ref": "#/components/schemas/Assets_74bfea69" }, "CIRCUIT": { "$ref": "#/components/schemas/Assets_74bfea69" } }, "description": "Updated assets to monitor, scoped by level type (CAGE, CABINET, CIRCUIT)" } } ], "result": { "name": "smartview_updatePowerAlertConfigurationResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update a power alert configuration", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "smartview_updateSubscription", "summary": "Update subscription", "description": "This endpoint allows users to modify and update an existing streaming subscription for a given organization. Request payload replaces current subscription.\n\nPart of the Equinix SmartView API family (smartview). Equinix Smart View is a comprehensive Data Center Infrastructure Management (DCIM) platform designed to facilitate advanced data collection related to customer deployments.", "tags": [ { "name": "smartview" }, { "name": "Streaming Subscription API" }, { "name": "colocation" }, { "name": "monitoring" }, { "name": "power" } ], "paramStructure": "by-name", "params": [ { "name": "id", "required": true, "schema": { "type": "string" } }, { "name": "messageType", "description": "Message type for a given subscription", "required": false, "schema": { "$ref": "#/components/schemas/MessageType" } }, { "name": "channel", "description": "Subscription can be created using one channel.", "required": false, "schema": { "$ref": "#/components/schemas/Channel" } } ], "result": { "name": "smartview_updateSubscriptionResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update subscription", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "sts_createOidcProvider", "summary": "Create OIDC Provider", "description": "Allows a user to register a new OIDC provider for a root project. The OIDC provider is registered in the project\n which owns the access policy being used. The `idpPrefix` is used to create a unique `idpId` for this usage of the OIDC\n provider within the root project. The `idpPrefix` cannot be the same as any existing, suspended or non-suspended, OIDC\n provider records for this root project. This operation creates a trust relationship between the root project and the\n OIDC provider such that identity tokens from the OIDC provider will be accepted for token exchange. Access control is\n fine-grained, based on the project in which an OIDC provider is being created.\n\nThe auth token's access policy must allow `action:use/createOidcProvider`.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-oidc-provider" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "name", "description": "A human-friendly name for the identity provider.", "required": true, "schema": { "type": "string", "maxLength": 100, "minLength": 2, "description": "A human-friendly name for the identity provider.", "example": "My OIDC Provider" } }, { "name": "trustedClientIds", "description": "List of OAuth 2.0 client ids for this provider that are permitted to exchange ID tokens for access tokens. The value of the `aud` claim in an ID token is checked against this list during token exchange.", "required": true, "schema": { "$ref": "#/components/schemas/TrustedClientIds" } }, { "name": "issuerLocation", "description": "The OIDC issuer location URL.", "required": true, "schema": { "type": "string", "maxLength": 2048, "minLength": 1, "description": "The OIDC issuer location URL.", "example": "https://example.com/oidc" } }, { "name": "idpPrefix", "required": true, "schema": { "type": "string", "pattern": "^[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,33}$", "example": "my-idp" } }, { "name": "groupMembershipClaim", "description": "Name of the claim in the ID tokens provided by this OIDC issuer whose value the STS should interpret as containing a user's group memberships, for authorization purposes. The value of the group membership claim in an ID token must be an array of strings, where each string is a unique, non-reassignable identifier for a group. When this property is not set, the STS does not interpret any claim from this provider as a group membership claim.", "required": false, "schema": { "$ref": "#/components/schemas/GroupMembershipClaim" } } ], "result": { "name": "sts_createOidcProviderResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Sts_createOidcProviderResult" } }, "x-mcp-annotations": { "title": "Create OIDC Provider", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "sts_deleteOidcProvider", "summary": "Delete OIDC Provider", "description": "Allows a user to permanently remove the trust relationship for an OIDC provider in a root project. This operation\n cannot be reversed. This operation causes the `idpId` of the OIDC provider to be permanently disabled for this root\n project. Even if `createOidcProvider` is used to register the same OIDC provider again it will be assigned a unique\n `idpId` within the root project. This operation applies for the project which owns the access policy being\n used. Access control is fine-grained based on the project which contains the OIDC provider.\n\nThe auth token's access policy must allow `action:use/deleteOidcProvider`.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-oidc-provider" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "idpId", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "required": true, "schema": { "type": "string", "pattern": "^idp:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "example": "idp:my-idp" } } ], "result": { "name": "sts_deleteOidcProviderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Delete OIDC Provider", "readOnlyHint": false, "destructiveHint": true, "idempotentHint": true, "openWorldHint": true } }, { "name": "sts_generateStsToken", "summary": "generate sts token", "description": "An OAuth 2.0 token endpoint supporting RFC 8693 token exchange, used to exchange an OIDC ID token issued by a trusted OIDC provider to a trusted client for an access token that can be used access other Equinix product APIs.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-pre-auth" } ], "paramStructure": "by-name", "params": [ { "name": "grantType", "description": "The OAuth 2.0 grant type.", "required": false, "schema": { "type": "string", "enum": [ "client_credentials", "urn:ietf:params:oauth:grant-type:token-exchange" ], "description": "The OAuth 2.0 grant type.", "example": "urn:ietf:params:oauth:grant-type:token-exchange" } }, { "name": "scope", "description": "Requested scope for the access token.", "required": false, "schema": { "type": "string", "description": "Requested scope for the access token.", "example": "accesspolicy:abc-123:idp:example-policy" } }, { "name": "subjectToken", "description": "The ID token to exchange.", "required": false, "schema": { "type": "string", "description": "The ID token to exchange.", "example": "eyJhbGciOiJSUzI1NiJ9..." } }, { "name": "subjectTokenType", "description": "The type of the subject token.", "required": false, "schema": { "type": "string", "enum": [ "urn:ietf:params:oauth:token-type:id_token" ], "description": "The type of the subject token.", "example": "urn:ietf:params:oauth:token-type:id_token" } } ], "result": { "name": "sts_generateStsTokenResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "accessToken": { "type": "string", "description": "The issued access token.", "example": "eyJhbGciOiJFUzI1NiJ9..." }, "issuedTokenType": { "type": "string", "enum": [ "urn:ietf:params:oauth:token-type:access_token" ], "description": "The type of the issued token.", "example": "urn:ietf:params:oauth:token-type:access_token" }, "tokenType": { "type": "string", "enum": [ "Bearer", "DPoP" ], "description": "The token type, e.g. Bearer.", "example": "Bearer" }, "expiresIn": { "type": "integer", "description": "Lifetime of the token in seconds.", "example": 3600 } }, "type": "object", "required": [ "accessToken", "issuedTokenType", "tokenType", "expiresIn" ], "description": "A successful OAuth 2.0 token response.", "x-fastmcp-top-level-schema": "TokenResponse" } }, "x-mcp-annotations": { "title": "generate sts token", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "sts_getJwks", "summary": "Get JSON Web Key Set", "description": "Returns the JSON Web Key Set used to verify tokens issued by this service.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-pre-auth" } ], "paramStructure": "by-name", "params": [], "result": { "name": "sts_getJwksResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "keys": { "items": { "properties": {}, "type": "object" }, "type": "array", "description": "Array of JSON Web Keys." } }, "type": "object", "required": [ "keys" ], "description": "A JSON Web Key Set (RFC 7517) containing the public keys used to verify tokens issued by this service.", "x-fastmcp-top-level-schema": "JwksResponse" } }, "x-mcp-annotations": { "title": "Get JSON Web Key Set", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "sts_getOpenIdConfiguration", "summary": "Get Well-Known OpenID Configuration", "description": "Returns the OpenID Connect discovery document for this service.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-pre-auth" } ], "paramStructure": "by-name", "params": [], "result": { "name": "sts_getOpenIdConfigurationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "issuer": { "type": "string", "description": "Issuer identifier URI.", "example": "https://sts.eqix.equinix.com" }, "jwksUri": { "type": "string", "description": "URI of the JSON Web Key Set.", "example": "https://sts.eqix.equinix.com/jwks" }, "tokenEndpoint": { "type": "string", "description": "URI of the token endpoint.", "example": "https://sts.eqix.equinix.com/use/token" }, "claimsSupported": { "items": { "type": "string" }, "type": "array", "description": "List of claim names the provider supports." }, "responseTypesSupported": { "items": { "type": "string" }, "type": "array", "description": "List of supported response types." }, "subjectTypesSupported": { "items": { "type": "string" }, "type": "array", "description": "List of supported subject identifier types." }, "idTokenSigningAlgValuesSupported": { "items": { "type": "string" }, "type": "array", "description": "List of JWS signing algorithms supported for the ID token." } }, "type": "object", "required": [ "issuer", "jwksUri", "tokenEndpoint", "claimsSupported", "responseTypesSupported", "subjectTypesSupported", "idTokenSigningAlgValuesSupported" ], "description": "An OpenID Connect discovery document (RFC 8414).", "x-fastmcp-top-level-schema": "OpenIdConfiguration" } }, "x-mcp-annotations": { "title": "Get Well-Known OpenID Configuration", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "sts_listAccessPoliciesGranted", "summary": "List Access Policies Granted", "description": "Lists the access policies granted to the subject identified by the given token within a project.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-pre-auth" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "subjectToken", "description": "An ID or access token indicating the subject to list granted access policies for", "required": true, "schema": { "type": "string", "maxLength": 4096, "description": "An ID or access token indicating the subject to list granted access policies for", "example": "eyJhbGciOiJSUzI1NiJ9..." } }, { "name": "subjectTokenType", "description": "Indicates whether the subject token is an ID token or access token", "required": true, "schema": { "type": "string", "enum": [ "urn:ietf:params:oauth:token-type:id_token" ], "description": "Indicates whether the subject token is an ID token or access token", "example": "urn:ietf:params:oauth:token-type:id_token" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20, "default": 100 } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } } ], "result": { "name": "sts_listAccessPoliciesGrantedResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "accessPolicyId": { "type": "string", "pattern": "^accesspolicy:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies an access policy within a project.", "example": "accesspolicy:my-policy" } }, "additionalProperties": false, "type": "object", "required": [ "accessPolicyId" ] }, "type": "array" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "Paginated list of access policy IDs granted to a subject within a project.", "x-fastmcp-top-level-schema": "ListAccessPoliciesGrantedOutput" } }, "x-mcp-annotations": { "title": "List Access Policies Granted", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "sts_pageOidcProviders", "summary": "List OIDC Providers", "description": "Allows a user to page through all of the OIDC providers which are defined for a root project.\n The project is identified by the project id or ern provided.\n Access control is fine-grained, based on the project whose OIDC providers are being listed.\n\nThe auth token's access policy must allow `action:use/pageOidcProviders`.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-oidc-provider" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "includeSuspended", "description": "When true, include suspended OIDC providers in the results.", "required": false, "schema": { "type": "boolean", "example": false, "description": "When true, include suspended OIDC providers in the results." } }, { "name": "pageToken", "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "required": false, "schema": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the PageToken is an opaque indicator that identifies a page.", "example": "eyJwYWdlIjoyfQ==" } }, { "name": "pageSize", "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "required": false, "schema": { "type": "integer", "maximum": 1000.0, "minimum": 1.0, "description": "When paging through results, this is an integer indicating the maximum number of results to return. Note, it is\n possible for fewer results to be returned even when the end of the result set has not been reached.", "example": 20 } } ], "result": { "name": "sts_pageOidcProvidersResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "properties": { "list": { "items": { "properties": { "jwks": { "$ref": "#/components/schemas/Jwks" }, "idpId": { "type": "string", "pattern": "^idp:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "example": "idp:my-idp" }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "issuerLocation": { "type": "string", "maxLength": 2048, "minLength": 1, "description": "The OIDC issuer location URL.", "example": "https://example.com/oidc" }, "name": { "type": "string", "maxLength": 100, "minLength": 2, "description": "A human-friendly name for the identity provider.", "example": "My OIDC Provider" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "issuerUri": { "type": "string", "pattern": "^https://[a-zA-Z0-9-.]+(:[1-9][0-9]{0,4})?((?:[-a-zA-Z0-9$_.+!*'(),/]|%[0-9a-fA-F]{2})+)?$", "description": "The value of the `iss` claim as returned by this provider. Must be unique within the root project.", "example": "https://example.com/oidc" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "status": { "type": "string", "enum": [ "ENABLED", "SUSPENDED" ], "description": "* \"ENABLED\": the provider is trusted, and token exchange is enabled\n * \"SUSPENDED\": token exchange for ID tokens from this provider is currently disabled", "example": "ENABLED" }, "groupMembershipClaim": { "$ref": "#/components/schemas/GroupMembershipClaim" }, "trustedClientIds": { "$ref": "#/components/schemas/TrustedClientIds" }, "jwksRetrievedAt": { "type": "string", "description": "Timestamp string formatted like: \"2025-02-13T17:10:00.864707507Z\".", "example": "2025-02-13T17:10:00.864707507Z" } }, "additionalProperties": false, "type": "object", "required": [ "name", "trustedClientIds", "idpId", "issuerUri", "issuerLocation", "jwks", "status", "jwksRetrievedAt", "createdBy", "createdAt", "rev" ], "description": "Represents a trust relationship with an OpenID Connect Identity Provider." }, "type": "array", "description": "A list of OIDC providers." }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of OIDC providers.", "x-fastmcp-top-level-schema": "OIDCProviderPage" } }, "x-mcp-annotations": { "title": "List OIDC Providers", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "sts_patchOidcProvider", "summary": "Patch OIDC Provider", "description": "Modify specific property values of an OIDCProvider, leaving the rest with their current values.\n Optional properties (e.g. groupMembershipClaims) may be unset by assigning them the value `{\"$unset\": true}`. Access\n control is fine-grained, based on the project containing the OIDC provider being updated.\n\nThe auth token's access policy must allow `action:use/patchOidcProvider`.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-oidc-provider" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "idpId", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "required": true, "schema": { "type": "string", "pattern": "^idp:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "example": "idp:my-idp" } }, { "name": "lastRev", "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "required": true, "schema": { "$ref": "#/components/schemas/LastRev" } }, { "name": "name", "description": "A human-friendly name for the identity provider.", "required": false, "schema": { "type": "string", "maxLength": 100, "minLength": 2, "description": "A human-friendly name for the identity provider.", "example": "My OIDC Provider" } }, { "name": "trustedClientIds", "description": "List of OAuth 2.0 client ids for this provider that are permitted to exchange ID tokens for access tokens. The value of the `aud` claim in an ID token is checked against this list during token exchange.", "required": false, "schema": { "$ref": "#/components/schemas/TrustedClientIds" } }, { "name": "groupMembershipClaim", "description": "Name of the claim in the ID tokens provided by this OIDC issuer whose value the STS should interpret as containing a user's group memberships, for authorization purposes. The value of the group membership claim in an ID token must be an array of strings, where each string is a unique, non-reassignable identifier for a group. When this property is not set, the STS does not interpret any claim from this provider as a group membership claim.", "required": false, "schema": { "description": "Name of the claim in the ID tokens provided by this OIDC issuer whose value the STS should interpret as containing a user's group memberships, for authorization purposes. The value of the group membership claim in an ID token must be an array of strings, where each string is a unique, non-reassignable identifier for a group. When this property is not set, the STS does not interpret any claim from this provider as a group membership claim.", "example": "groups", "anyOf": [ { "properties": { "$unset": { "const": true, "example": true } }, "additionalProperties": false, "type": "object", "required": [ "$unset" ] }, { "type": "string", "maxLength": 100, "minLength": 2 } ] } } ], "result": { "name": "sts_patchOidcProviderResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "$ref": "#/components/schemas/Sts_createOidcProviderResult" } }, "x-mcp-annotations": { "title": "Patch OIDC Provider", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "sts_resumeOidcProvider", "summary": "Resume OIDC Provider", "description": "Allows a user to restore the trust relationship for an OIDC provider in a root project. This operation applies for\n the project which owns the access policy being used. Access control is fine-grained based on the project which\n contains the OIDC provider.\n\nThe auth token's access policy must allow `action:use/resumeOidcProvider`.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-oidc-provider" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "idpId", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "required": true, "schema": { "type": "string", "pattern": "^idp:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "example": "idp:my-idp" } } ], "result": { "name": "sts_resumeOidcProviderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Resume OIDC Provider", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "sts_suspendOidcProvider", "summary": "Suspend OIDC Provider", "description": "Allows a user to indicate that an OIDC provider is no longer trusted in a root project. This operation applies for\n the project which owns the access policy being used. This operation can be reversed via `resumeOidcProvider`. This\n operation provides a reversible way to turn off token exchange for identity tokens from an OIDC provider. Access\n control is fine-grained based on the project which contains the OIDC provider.\n\nThe auth token's access policy must allow `action:use/suspendOidcProvider`.\n\nPart of the Equinix Security Token Service API family (sts). Security Token Service (STS): exchange OIDC ID tokens for Equinix access tokens.", "tags": [ { "name": "sts" }, { "name": "auth" }, { "name": "identity" }, { "name": "v1-oidc-provider" } ], "paramStructure": "by-name", "params": [ { "name": "projectId", "description": "Globally unique identifier of a project.", "required": true, "schema": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } }, { "name": "idpId", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "required": true, "schema": { "type": "string", "pattern": "^idp:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "example": "idp:my-idp" } } ], "result": { "name": "sts_suspendOidcProviderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Suspend OIDC Provider", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "support_cancelTicket", "summary": "Cancel a trouble ticket by case / order number", "description": "This method cancels a trouble ticket by case or order number.\n\nPart of the Equinix Case Management API family (support). The API for the Case Management Service.", "tags": [ { "name": "support" }, { "name": "Trouble Ticket / Case" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Case or order number.", "required": true, "schema": { "maxLength": 100, "minLength": 8, "type": "string", "description": "Case or order number.", "example": "ex: 11150929 or 1-204976070710" } }, { "name": "reason", "description": "Enter any cancellation details.", "required": false, "schema": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any cancellation details.", "example": "This is a reason!" } } ], "result": { "name": "support_cancelTicketResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Cancel Case Request Response", "required": [ "result" ], "type": "object", "properties": { "status": { "enum": [ "OK" ], "type": "string", "description": "Status of the cancellation request.", "example": "OK" } }, "x-fastmcp-top-level-schema": "CancelCaseResponse" } }, "x-mcp-annotations": { "title": "Cancel a trouble ticket by case / order number", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "support_createTicketsV2", "summary": "Create a trouble ticket / case", "description": "This method create a trouble ticket or case.\n\nPart of the Equinix Case Management API family (support). The API for the Case Management Service.", "tags": [ { "name": "support" }, { "name": "Trouble Ticket / Case" } ], "paramStructure": "by-name", "params": [ { "name": "code", "description": "Ticket code.", "required": false, "schema": { "enum": [ "0000-0000", "0000-0002", "0002-0000", "0002-0001", "0003-0000", "0003-0001", "0003-0002", "0003-0003", "0004-0000", "0004-0001", "0005-0000", "0005-0001", "0007-0000", "0007-0001", "0007-0002", "0007-0003", "0007-0004", "0010-0000", "0010-0001", "0010-0002", "0010-0003", "0010-0004", "0010-0005", "0011-0000", "0011-0001", "0011-0002", "0011-0003", "0011-0004", "0011-0005", "0012-0000", "0012-0001", "0012-0002", "0012-0003", "0012-0004", "0012-0005", "0013-0001", "0013-0002", "0013-0003", "0014-0002", "0014-0003", "0014-0004", "0014-0005", "0015-0000", "0015-0001", "0015-0002", "0015-0003", "0015-0004", "0015-0100", "0015-0101", "0015-0102", "0015-0103", "0015-0105", "0015-0106", "0015-0107", "0015-0200", "0015-0201", "0100-0000", "0100-0100", "0100-0200", "0100-0300", "0100-0400", "0100-0500", "0101-0000", "0101-0100", "0102-0000", "0102-0100", "0102-0200", "0102-0300", "0102-0400", "0102-0500", "0102-0600", "0103-0000", "0103-0100", "0104-0000", "0104-0100", "0104-0200", "0104-0300", "0104-0400", "0104-0500", "0105-0000", "0105-0100", "0105-0200", "0105-0300", "0105-0400", "0105-0500", "0105-0600", "0106-0000", "0106-0100", "0107-0000", "0107-0100", "0107-0200", "0107-0300", "0107-0400", "0108-0000", "0108-0100", "0200-0000", "0200-0100", "0200-0200", "0200-0300", "0200-0400", "0200-0500", "0200-0600", "0200-0700", "0200-0800", "0200-0900", "0200-1000", "0200-1100", "0200-1200", "0200-1300", "0201-0000", "0201-0100", "0201-0200", "0201-0300", "0202-0000", "0202-0100", "0203-0000", "0203-0100", "0203-0200", "0203-0300", "0204-0000", "0204-0001", "0205-0000", "0205-0100", "0300-0000", "0300-0100", "0300-0200", "0300-0300", "0300-0400", "0301-0000", "0301-0100", "0302-0000", "0302-0100", "0302-0200", "0302-0300", "0302-0400", "0302-0500", "0302-0600", "0302-0700", "0303-0000", "0303-0100", "0304-0000", "0304-0100", "0304-0200", "0304-0300", "0304-0400", "0304-0500", "0304-0600", "0305-0000", "0305-0001", "0305-0002", "0305-0003", "0305-0100", "0305-0200", "0305-0300", "0305-0301", "0305-0302", "0305-0400", "0305-0500", "0305-0600", "0305-0700", "0306-0000", "0306-0100", "0306-0200", "0306-0300", "0500-0000", "0500-0100", "0500-0200", "0500-0300", "0500-0400", "0500-0500", "0500-0600", "0500-0700", "0501-0000", "0501-0100", "0502-0000", "0502-0100", "0502-0200", "0502-0300", "0502-0400", "0502-0500", "0502-0600", "0800-0000" ], "type": "string", "description": "Ticket code.", "example": "0200-0000" } }, { "name": "description", "description": "Description of the trouble or issue.", "required": false, "schema": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Description of the trouble or issue.", "example": "The device is overheating and causing performance issues." } }, { "name": "primaryId", "description": "Primary reference identifier.", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Primary reference identifier.", "example": "__ENTER_DEVICE_UUID_HERE__" } }, { "name": "secondaryId", "description": "Secondary reference identifier.", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Secondary reference identifier.", "example": "__ENTER_SECONDARY_ID_HERE__" } }, { "name": "occurredDateTime", "description": "Date and time the issue occurred.", "required": false, "schema": { "type": "string", "description": "Date and time the issue occurred.", "format": "date-time", "example": "2020-05-22T19:23:51Z" } }, { "name": "customerReferenceId", "description": "Customer or external reference number.", "required": false, "schema": { "maxLength": 200, "minLength": 1, "type": "string", "description": "Customer or external reference number.", "example": "CustomerReference001" } }, { "name": "attachments", "description": "Supporting files to attach in the ticket, such as a picture of a broken device.", "required": false, "schema": { "maxItems": 5, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_732c8a2f" }, "description": "Supporting files to attach in the ticket, such as a picture of a broken device." } }, { "name": "contacts", "description": "List of persons who will be contacted for this ticket.", "required": false, "schema": { "type": "array", "items": { "anyOf": [ { "required": [ "registeredUsers", "type" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "type": "array", "items": { "type": "string", "example": "john_doe" }, "description": "Username of a registered user." }, "type": { "enum": [ "NOTIFICATION", "ORDERING", "TECHNICAL" ], "type": "string", "description": "Type of the contact.", "example": "NOTIFICATION" } }, "description": "Contact information of a registered user. Ensure that the user status of this contact is approved, active or locked." }, { "required": [ "details", "type" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Don" }, "type": { "enum": [ "NOTIFICATION", "ORDERING", "TECHNICAL" ], "type": "string", "description": "Type of the contact.", "example": "NOTIFICATION" }, "details": { "maxItems": 3, "minItems": 2, "type": "array", "items": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "enum": [ "EMAIL", "MOBILE", "PHONE" ], "type": "string", "description": "Communication type.", "example": "PHONE" }, "value": { "type": "string", "description": "Unique identifier of related type.", "example": "+1-4601231122" } }, "description": "Contact details." }, "description": "Reference of the related party, could be a party reference or a party role reference." } }, "description": "Contact information of a non-registered contact, including contact details." } ] }, "description": "List of persons who will be contacted for this ticket." } }, { "name": "details", "description": "List of additional details or requirements to support ticket resolution, depending on the issues you are facing.", "required": false, "schema": { "anyOf": [ { "required": [ "requestedTerminationDate" ], "type": "object", "properties": { "requestedTerminationDate": { "type": "string", "description": "Preferred termination date.", "format": "date", "example": "2026-09-01" } } }, { "required": [ "requestedTerminationDate" ], "type": "object", "properties": { "requestedTerminationDate": { "type": "string", "description": "Preferred termination date.", "format": "date", "example": "2026-09-01" } } }, { "required": [ "requestedTerminationDate", "cage" ], "type": "object", "properties": { "requestedTerminationDate": { "type": "string", "description": "Preferred termination date.", "format": "date", "example": "2026-09-01" }, "cage": { "type": "string", "description": "Cage number.", "example": "DC11:01:501223" }, "cabinet": { "type": "string", "description": "Cabinet number.", "example": "DC11:01:501223:Demarc" } } }, { "required": [ "details" ], "type": "object", "properties": { "details": { "type": "object", "properties": { "documents": { "required": [ "transactionIds", "type", "formats" ], "type": "object", "properties": { "transactionIds": { "maxItems": 20, "minItems": 1, "type": "array", "items": { "type": "string", "example": "1234567890" }, "description": "List of transaction numbers such as invoice, credit memo or payment numbers." }, "type": { "enum": [ "DETAILED", "SUMMARY" ], "type": "string", "description": "Transaction document view type.", "example": "DETAILED" }, "formats": { "maxItems": 2, "minItems": 1, "type": "array", "items": { "enum": [ "XLS", "PDF" ], "type": "string", "description": "Document file format.", "example": "XLS" }, "description": "Document file format.", "example": [ "XLS", "PDF" ] } } } }, "description": "Details" } } }, { "required": [ "orderIds" ], "type": "object", "properties": { "orderIds": { "maxItems": 20, "minItems": 1, "type": "array", "items": { "type": "string", "example": "1234567890" }, "description": "List of order numbers." } } }, { "required": [ "transactionIds" ], "type": "object", "properties": { "transactionIds": { "maxItems": 20, "minItems": 1, "type": "array", "items": { "type": "string", "example": "1234567890" }, "description": "List of transaction numbers such as invoice, credit memo or payment numbers." } } }, { "required": [ "transactionIds" ], "type": "object", "properties": { "transactionIds": { "maxItems": 20, "minItems": 1, "type": "array", "items": { "type": "string", "example": "1234567890" }, "description": "List of transaction numbers such as invoice, credit memo or payment numbers." } } }, { "type": "object", "properties": { "companyName": { "type": "string", "description": "New company name.", "example": "New Company" }, "companyLocalName": { "type": "string", "description": "New company name in local language.", "example": "New Company - Local" }, "vatNumber": { "type": "string", "description": "New VAT or tax registration number.", "example": "1234567890" } } }, { "required": [ "address" ], "type": "object", "properties": { "address": { "required": [ "addressLine1", "zipCode", "countryCode" ], "type": "object", "properties": { "addressLine1": { "type": "string", "description": "Address line 1. Example: Street, PO Box, etc...", "example": "Amoy Street 123" }, "addressLine2": { "type": "string", "description": "Address line 2. Example: Suite, Unit, Building, etc...", "example": "Chai Chee Road 2" }, "city": { "type": "string", "description": "City, County, Province, Region.", "example": "Singapore" }, "state": { "type": "string", "description": "State.", "example": "Singapore" }, "zipCode": { "type": "string", "description": "ZIP or postal code.", "example": "199597" }, "countryCode": { "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CS", "CU", "CV", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IN", "IO", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", false, "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string", "description": "2-letter country code.", "example": "SG" } }, "description": "Address" } } }, { "required": [ "contacts" ], "type": "object", "properties": { "contacts": { "type": "array", "items": { "required": [ "type", "firstName", "lastName", "details" ], "type": "object", "properties": { "type": { "maxItems": 4, "minItems": 1, "enum": [ "BILLING", "PAYMENT", "PURCHASE_ORDER", "FINANCE" ], "type": "array", "items": { "type": "string", "example": "BILLING" }, "description": "Type of contact role. Our company will reach out to this person regarding information specific to their contact role." }, "firstName": { "type": "string", "description": "First name of the contact person.", "example": "Ali" }, "lastName": { "type": "string", "description": "Last name of the contact person.", "example": "Mhn" }, "localName": { "type": "string", "description": "Full name of contact person in local language.", "example": "Ali Local" }, "details": { "type": "array", "items": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "enum": [ "EMAIL", "PHONE" ], "type": "string", "description": "Communication type.", "example": "EMAIL" }, "value": { "type": "string", "description": "Email or phone number.", "example": "XXX@XXX.COM or +65-123456789" } } } } } }, "description": "Contact information." } } }, { "$ref": "#/components/schemas/Details_435efc1e" }, { "$ref": "#/components/schemas/Details_435efc1e" }, { "$ref": "#/components/schemas/Details_435efc1e" }, { "$ref": "#/components/schemas/Details_435efc1e" }, { "type": "object", "properties": { "severity": { "enum": [ "P1", "P2", "P3", "P4" ], "type": "string", "description": "Priority level of the issue. P1 is the highest priority and P4 is the lowest.", "example": "P1" } }, "description": "Additional details for Equinix Fabric and Network Edge tickets." } ], "description": "List of additional details or requirements to support ticket resolution, depending on the issues you are facing." } } ], "result": { "name": "support_createTicketsV2Result", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Create Case Request Response", "required": [ "id", "type" ], "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 8, "type": "string", "description": "Case or order number.", "example": "ex: 11150929 or 1-204976070710" }, "type": { "enum": [ "CASE", "TROUBLE" ], "type": "string", "description": "Ticket type.", "example": "CASE" } }, "x-fastmcp-top-level-schema": "TicketResponse" } }, "x-mcp-annotations": { "title": "Create a trouble ticket / case", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "support_downloadAttachment", "summary": "Download an attachment by case ID and attachment ID", "description": "This method downloads an attachment by case ID and attachment ID.\n\nPart of the Equinix Case Management API family (support). The API for the Case Management Service.", "tags": [ { "name": "support" }, { "name": "Attachment" }, { "name": "Case" } ], "paramStructure": "by-name", "params": [ { "name": "caseId", "description": "Case number.", "required": true, "schema": { "maxLength": 8, "minLength": 8, "type": "string", "description": "Case number.", "example": "11150929" } }, { "name": "attachmentId", "description": "Attachment ID.", "required": true, "schema": { "type": "string", "description": "Attachment ID." } } ], "result": { "name": "support_downloadAttachmentResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "result": { "type": "string", "format": "binary" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true } }, "x-mcp-annotations": { "title": "Download an attachment by case ID and attachment ID", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "support_getEmailDetailsByCaseNumber", "summary": "Get email details by email ID and case number", "description": "This method retrieves email details by email ID and case number.\n\nPart of the Equinix Case Management API family (support). The API for the Case Management Service.", "tags": [ { "name": "support" }, { "name": "Case" }, { "name": "Email" } ], "paramStructure": "by-name", "params": [ { "name": "caseNumber", "description": "Case number.", "required": true, "schema": { "maxLength": 8, "minLength": 8, "type": "string", "description": "Case number.", "example": "11150929" } }, { "name": "emailId", "description": "Identifier of the email.", "required": true, "schema": { "maxLength": 18, "minLength": 18, "type": "string", "description": "Identifier of the email.", "example": "02s7z00000D30lZAAR" } } ], "result": { "name": "support_getEmailDetailsByCaseNumberResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Identifier of the order/case the email is associated with.", "example": "11768081" }, "createdDateTime": { "type": "string", "description": "Date and time the email was created.", "format": "date-time", "example": "2026-06-26T08:27:45.000+0000" }, "subject": { "type": "string", "description": "Subject of the email.", "example": "Portal Support Ticket: General Inquiry - Case 11768081" }, "email_content": { "type": "string", "description": "HTML Body content of the email.", "example": "Write an email" }, "FromAddress": { "type": "string", "description": "Email address of the email author.", "example": "abc@equinix.com" }, "ToAddress": { "type": "string", "description": "Semi-colon separated email address(es) of the email recipients.", "example": "xyz@example.com" }, "CCAddress": { "type": "string", "description": "Semi-colon separated email address(es) of the email CC recipients.", "example": "opq@example.com" } }, "x-fastmcp-top-level-schema": "EmailDetailsResponse" } }, "x-mcp-annotations": { "title": "Get email details by email ID and case number", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "support_getTicketDetails", "summary": "Get a trouble ticket by case / order number", "description": "This method get a trouble ticket by case or order number.\n\nPart of the Equinix Case Management API family (support). The API for the Case Management Service.", "tags": [ { "name": "support" }, { "name": "Trouble Ticket / Case" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Case or order number.", "required": true, "schema": { "maxLength": 100, "minLength": 8, "type": "string", "description": "Case or order number.", "example": "ex: 11150929 or 1-204976070710" } } ], "result": { "name": "support_getTicketDetailsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Get a Case by Case or Order Number Response", "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 8, "type": "string", "description": "Case or order number.", "example": "ex: 11150929 or 1-204976070710" }, "accountNumber": { "maxLength": 100, "minLength": 6, "type": "string", "description": "User account number.", "example": "182389736" }, "accountName": { "type": "string", "description": "User account name.", "example": "VjT Existing Reseller New BA" }, "customerReferenceId": { "type": "string", "description": "Additional information for customer to reference.", "example": "EESkFTupLmnF6KinbARfNgWAC2V1BZbDZKluF5TI5YVTXTfGkF" }, "channel": { "enum": [ "OFFLINE", "PORTAL" ], "type": "string", "description": "Channel through which the case was created.", "example": "PORTAL" }, "orderId": { "maxLength": 100, "minLength": 14, "type": "string", "description": "Order number.", "example": "1-204976070710" }, "location": { "type": "object", "properties": { "ibx": { "type": "array", "items": { "type": "string", "description": "IBX", "example": "SV5" }, "description": "IBX location(s)." } } }, "status": { "enum": [ "SUBMITTED", "IN_PROGRESS", "RESOLVED", "ACTION_REQUIRED", "CLOSED", "CANCELLED" ], "type": "string", "description": "Case status.", "example": "IN_PROGRESS" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Don" }, "type": { "enum": [ "NOTIFICATION", "ORDERING", "TECHNICAL" ], "type": "string", "description": "Type of the contact.", "example": "NOTIFICATION" }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "EMAIL", "MOBILE", "PHONE" ], "type": "string", "description": "Communication type.", "example": "EMAIL" }, "value": { "type": "string", "description": "Corresponding value according to the Communication Type.", "example": "SomeContact@email.com" } } } } } }, "description": "Contacts" }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ID of the note" }, "createdDateTime": { "type": "string", "description": "A datetime string with format YYYY-MM-DDTHH:mm:ss.sssZ.", "format": "date-time", "example": "2023-08-29T04:01:43Z" }, "text": { "type": "string", "description": "The content of the note.", "example": "This is a note." }, "type": { "enum": [ "RESOLUTION_NOTES", "CUSTOMER_NOTES" ], "type": "string", "description": "The type of the note.", "example": "RESOLUTION_NOTES" } } } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_73586a8c" } }, "email": { "type": "array", "items": { "minItems": 0, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the email.", "example": "02s7z00000D30lZAAR" }, "createdDateTime": { "type": "string", "description": "Date and time the email was created.", "format": "date-time", "example": "2023-08-29T04:01:43.000Z" }, "subject": { "type": "string", "description": "Subject of the email.", "example": "Issue with device" }, "author_name": { "type": "string", "description": "Name of the email author.", "example": "Ali bin Carud" }, "FromAddress": { "type": "string", "description": "Email address of the email author.", "example": "abc@equinix.com" }, "ToAddress": { "type": "string", "description": "Email address of the email recipient.", "example": "xyz@example.com" } }, "description": "Email conversation attached to the ticket. e.g. email conversation with a technician, email conversation with a customer, etc..." }, "description": "Email conversation(s) attached to the ticket. e.g. email conversation with a technician, email conversation with a customer, etc..." } }, "createdDateTime": { "type": "string", "description": "A datetime string with format YYYY-MM-DDTHH:mm:ss.sssZ.", "format": "date-time", "example": "2023-08-29T04:01:43Z" }, "otherDetails": { "type": "object", "properties": { "contactUCMID": { "type": "string", "example": "236284" }, "recordType": { "enum": [ "ECM", "GSD Case" ], "type": "string", "example": "ECM" }, "subChannel": { "enum": [ "ECP" ], "type": "string", "example": "ECP" }, "finalScheduledDate": { "type": "string", "description": "A datetime string with format YYYY-MM-DDTHH:mm:ss.sssZ.", "format": "date-time", "example": "2023-08-29T04:01:43Z" }, "category": { "type": "string", "example": "Trouble Services" }, "subCategory": { "type": "string", "example": "Incident" }, "description": { "type": "string", "example": "Sample description." }, "updatedDateTime": { "type": "string", "description": "A datetime string with format YYYY-MM-DDTHH:mm:ss.sssZ.", "format": "date-time", "example": "2023-08-29T04:01:43Z" }, "updatedByFullName": { "type": "string", "example": "0052H000003iLJjQAM" }, "requestedTerminationDate": { "type": "string", "format": "date", "example": "2026-09-01" }, "statusHistory": { "type": "array", "items": { "type": "object", "properties": { "status": { "enum": [ "SUBMITTED", "IN_PROGRESS", "RESOLVED", "ACTION_REQUIRED", "CLOSED", "CANCELLED" ], "type": "string", "description": "Case status.", "example": "IN_PROGRESS" }, "createdDate": { "type": "string", "description": "A datetime string with format YYYY-MM-DDTHH:mm:ss.sssZ.", "format": "date-time", "example": "2023-08-29T04:01:43Z" } } } }, "purchaseOrders": { "type": "array", "items": { "type": "string", "example": "PO.1234" } }, "products": { "type": "array", "items": { "type": "string", "example": "SMART_HANDS" } }, "productOfferingCodes": { "type": "array", "items": { "type": "string", "example": "PS00001.PROD" } }, "details": { "type": "array", "items": { "type": "object", "properties": { "lineId": { "type": "string", "example": "1-2RCPXBUV" }, "parentLineId": { "type": "string", "example": "1-2RCPXBUK" }, "productType": { "enum": [ "SMART_HANDS" ], "type": "string", "example": "SMART_HANDS" }, "productOfferingCode": { "type": "string", "example": "PS00001.PROD" }, "productCode": { "type": "string", "example": "PS00040.ELEM" }, "productName": { "type": "string", "example": "Other" }, "status": { "enum": [ "IN_PROGRESS", "CANCELLED", "SUBMITTED", "CLOSED", "ACTION_REQUIRED", "RESOLVED" ], "type": "string", "example": "SUBMITTED" }, "reOpen": { "type": "string", "example": "NOT_ALLOWED" }, "respond": { "type": "boolean", "example": true }, "ibx": { "type": "string", "example": "DA3" }, "cage": { "type": "string", "example": "DA3:01:010315" }, "requestType": { "enum": [ "ADD" ], "type": "string", "example": "ADD" }, "activityId": { "type": "string", "example": "3-216270588333" }, "purchaseOrder": { "type": "object", "example": {} }, "estimatedCompletion": { "type": "object", "properties": { "originalDateTime": { "type": "string", "format": "date-time", "example": "2023-08-29T04:01:43.000Z" } } }, "updatedDateTime": { "type": "string", "format": "date-time", "example": "2023-08-29T04:01:43.000Z" }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "IS_RECURRING" }, "value": { "type": "boolean", "example": true } } } }, "modifiable": { "type": "boolean", "example": false }, "cancellable": { "type": "boolean", "example": true } } } }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "example": "RECURRING_TYPE" }, "value": { "type": "string", "example": "CHILD" } } } }, "modifiable": { "type": "boolean", "example": false }, "reOpen": { "type": "boolean", "example": false }, "cancellable": { "type": "boolean", "example": true }, "respond": { "type": "boolean", "example": true } } } }, "x-fastmcp-top-level-schema": "SingleCaseResponseV2" } }, "x-mcp-annotations": { "title": "Get a trouble ticket by case / order number", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "support_modifyTicketDetailsByCaseNumber", "summary": "Modify a case by case number", "description": "This method modify a case by case number.\n\nPart of the Equinix Case Management API family (support). The API for the Case Management Service.", "tags": [ { "name": "support" }, { "name": "Trouble Ticket / Case" } ], "paramStructure": "by-name", "params": [ { "name": "caseNumber", "description": "Case number.", "required": true, "schema": { "maxLength": 8, "minLength": 8, "type": "string", "description": "Case number.", "example": "11150929" } }, { "name": "text", "description": "Enter any modification details/additional notes to the technician.", "required": false, "schema": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any modification details/additional notes to the technician.", "example": "This is a notes!" } }, { "name": "attachments", "description": "File(s) attached to the trouble ticket. e.g. picture of broken device, scanning of a bill or charge, etc...", "required": false, "schema": { "$ref": "#/components/schemas/AttachmentsItem_73586a8c" } } ], "result": { "name": "support_modifyTicketDetailsByCaseNumberResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Modify Case Request Response", "required": [ "result" ], "type": "object", "properties": { "result": { "type": "object", "properties": { "caseId": { "type": "string", "example": "5007i00000AUPOIAA5" }, "caseNotesId": { "type": "string", "example": "a067i000007miaAAAQ" }, "caseNumber": { "maxLength": 8, "minLength": 8, "type": "string", "description": "Case number.", "example": "11150929" } }, "description": "Result of the modification request." } }, "x-fastmcp-top-level-schema": "ModifyCaseResponse" } }, "x-mcp-annotations": { "title": "Modify a case by case number", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "support_modifyTicketDetailsById", "summary": "Modify a ticket by ID", "description": "This method adds a note to a ticket by ID.\n\nPart of the Equinix Case Management API family (support). The API for the Case Management Service.", "tags": [ { "name": "support" }, { "name": "Trouble Ticket / Case" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Case or order number.", "required": true, "schema": { "maxLength": 100, "minLength": 8, "type": "string", "description": "Case or order number.", "example": "ex: 11150929 or 1-204976070710" } }, { "name": "text", "description": "Enter any modification details/additional notes to the technician.", "required": false, "schema": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Enter any modification details/additional notes to the technician.", "example": "This is a notes!" } }, { "name": "attachments", "description": "File(s) attached to the trouble ticket. e.g. picture of broken device, scanning of a bill or charge, etc...", "required": false, "schema": { "$ref": "#/components/schemas/AttachmentsItem_73586a8c" } } ], "result": { "name": "support_modifyTicketDetailsByIdResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Modify Ticket Request Response", "type": "object", "properties": { "ticketId": { "maxLength": 100, "minLength": 8, "type": "string", "description": "Case or order number.", "example": "ex: 11150929 or 1-204976070710" }, "success": { "type": "boolean", "description": "Indicates whether the modification or reply was successful.", "example": true } }, "x-fastmcp-top-level-schema": "ModifyTicketResponse" } }, "x-mcp-annotations": { "title": "Modify a ticket by ID", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "supportplans_Retrieve_Smart_Hands_support_plans", "summary": "Retrieve Smart Hands support plans", "description": "This method retrieves all the available Smart Hands support plans and its remaining minutes to consume for a user with Smart Hands support plans viewing permission.\n\nPart of the Equinix Smarthands Support Plans API family (supportplans). The Smart Hands Support plan API allows users to retrieve information of their purchased plan. Information includes but is not limited to plan name, plan type, purchased minutes, consumed minutes, and remaining minutes for Smart Hands.", "tags": [ { "name": "supportplans" }, { "name": "Smart Hands Support Plans" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "accountNumbers", "description": "List of accounts to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of accounts to be filtered" } }, { "name": "ibxs", "description": "List of IBXs to be filtered", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of IBXs to be filtered" } }, { "name": "offset", "description": "Use `offset` to control the number of records to be skipped in the response.", "required": false, "schema": { "minimum": 0.0, "type": "integer", "default": 0, "description": "Use `offset` to control the number of records to be skipped in the response." } }, { "name": "limit", "description": "Use `limit` to restrict the number of records in the response.", "required": false, "schema": { "maximum": 200.0, "minimum": 1.0, "type": "integer", "default": 10, "description": "Use `limit` to restrict the number of records in the response." } }, { "name": "sorts", "description": "Sort the users in the response in a particular order. For descending order, prefix the field name with '-'.", "required": false, "schema": { "type": "array", "items": { "enum": [ "START_DATE", "-START_DATE", "END_DATE", "-END_DATE", "ACCOUNT_NUMBER", "-ACCOUNT_NUMBER", "ID", "-ID", "PLAN_NAME", "-PLAN_NAME" ], "type": "string", "default": "ACCOUNT_NUMBER" }, "description": "Sort the users in the response in a particular order. For descending order, prefix the field name with '-'." } }, { "name": "planIds", "description": "List of PlanIds to be filtered", "required": false, "schema": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "List of PlanIds to be filtered" } } ], "result": { "name": "supportplans_Retrieve_Smart_Hands_support_plansResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "title": "support plan details response", "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the specific plan. Note that `id` can be repeated for rollover plans or plan assignment. " }, "accountNumber": { "type": "string", "description": "Account number of the owner of support plan " }, "planName": { "type": "string", "description": "Name of support plan" }, "productCode": { "type": "string", "description": "Equinix product catalog code" }, "ibxs": { "type": "array", "items": { "type": "string" }, "description": "List of IBXs where support plans can be used" }, "ibxSpecific": { "type": "boolean", "description": "When `true`, support plans can only be used on a specific IBX. " }, "planFrequency": { "enum": [ "MONTHLY", "ANNUAL", "MONTHLY_ROLLOVER" ], "type": "string", "description": "Plan frequency " }, "purchasedMinutes": { "type": "integer", "description": "Shows the number of minutes purchased for a specific plan" }, "assignedMinutes": { "type": "integer", "description": "Shows the number of minutes assigned for a specific plan when plan is pro-rated. Plans are pro-rated when they are not purchased on the 1st of the month." }, "consumedMinutes": { "type": "integer", "description": "Shows the number of minutes consumed for a specific plan" }, "remainingMinutes": { "type": "integer", "description": "Shows the number of minutes remaining for a specific plan" }, "previousConsumedMinutes": { "type": "integer", "description": "Shows the number of minutes consumed in the previous month. This is only applicable for `MONTHLY` and `MONTHLY_ROLLOVER`" }, "currentConsumedMinutes": { "type": "integer", "description": "Shows the number of minutes consumed in the current month. This is only applicable for `MONTHLY` and `MONTHLY_ROLLOVER`" }, "prepaidConsumedMinutes": { "type": "integer", "description": "Shows the number of minutes consumed for prepaid plans. This is only applicable if plan frequency is of `ANNUAL` " }, "transitionMinutes": { "type": "integer", "description": "Shows the number of minutes assigned to your end customer. Applicable to resellers only." }, "startDate": { "type": "string", "description": "Plan start date in `YYYY-MM-DD` format", "format": "date" }, "endDate": { "type": "string", "description": "Plan end date `YYYY-MM-DD` format", "format": "date" }, "status": { "enum": [ "ACTIVE", "CANCELLED" ], "type": "string", "description": "Status of support plan. This can be of `ACTIVE` or `CANCELLED` " }, "createdDateTime": { "type": "string", "description": "Shows the date and time when support plan was created in ISO 8601 format", "format": "date-time" }, "updatedDateTime": { "type": "string", "description": "Shows the date and time when support plan was last updated in ISO 8601 format.", "format": "date-time" }, "assignment": { "type": "object", "properties": { "name": { "type": "string", "description": "Customer name of assigned plans" }, "accountNumber": { "type": "string", "description": "Customer account number of assigned plans" }, "status": { "enum": [ "ASSIGNED", "UNASSIGNED", "PENDING_ASSIGNED", "PENDING_UNASSIGNED", "CANCELLED" ], "type": "string", "description": "Shows the current status of assignment." }, "eligible": { "type": "boolean", "description": "When `true`, plans can be assigned to customers" } }, "description": "Customer assignment details. This information's is available for reseller" } } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "example": 0 }, "limit": { "type": "integer", "example": 25 }, "total": { "type": "integer", "example": 100 }, "next": { "type": "string", "example": "/supportPlans?offset=25&limit=25" }, "previous": { "type": "string", "example": "/supportPlans?offset=0&limit=25" } }, "description": "Pagination" } }, "description": "Support plan response", "x-fastmcp-top-level-schema": "supportPlanResponse" } }, "x-mcp-annotations": { "title": "Retrieve Smart Hands support plans", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "tickets_Add_notes_to_ticket", "summary": "Add notes to ticket", "description": "This method adds notes to a ticket by its ID for a user with permission to view this request.\n\nPart of the Equinix Tickets API family (tickets). Tickets should be entered for requests that require an immediate response based on interruption or loss of your service. If the service loss or interruption was caused by Equinix, it will not incur any charges. If the issue was not caused by Equinix, there will be additional Smart Hands charges.", "tags": [ { "name": "tickets" }, { "name": "Tickets" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Identifier of the ticket", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Identifier of the ticket" } }, { "name": "text", "description": "The text of the note.", "required": true, "schema": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "The text of the note.", "example": "More details to the ticket" } }, { "name": "referenceId", "description": "Reference identification related to troubleshooting activity.", "required": false, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Reference identification related to troubleshooting activity.", "example": "5-2000000000" } }, { "name": "attachments", "description": "File(s) attached to the ticket. e.g. picture of broken device, scanned copy of bill or charge. To learn about including attachments in your request, see POST Attachments API.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_861931ea" } } ], "result": { "name": "tickets_Add_notes_to_ticketResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Add notes to ticket", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "tickets_Cancel_a_ticket", "summary": "Cancel a ticket", "description": "This method cancels a ticket by its ID for a user with permission to view this request.\n\nPart of the Equinix Tickets API family (tickets). Tickets should be entered for requests that require an immediate response based on interruption or loss of your service. If the service loss or interruption was caused by Equinix, it will not incur any charges. If the issue was not caused by Equinix, there will be additional Smart Hands charges.", "tags": [ { "name": "tickets" }, { "name": "Tickets" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Identifier of the ticket.", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Identifier of the ticket." } }, { "name": "reason", "description": "Description of the trouble or issue.", "required": true, "schema": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "Description of the trouble or issue.", "example": "Duplicate ticket was raised, and issue was already resolved. Refer to ticket id 1-100000000000." } }, { "name": "attachments", "description": "File(s) attached to the ticket. e.g. picture of broken device, scanned copy of bill or charge. To learn about including attachments in your request, see POST Attachments API.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_861931ea" } } ], "result": { "name": "tickets_Cancel_a_ticketResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Cancel a ticket", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "tickets_Create_a_Ticket", "summary": "Create a Ticket", "description": "This method creates a ticket at locations where a user has trouble ticket ordering permission.\n\nPart of the Equinix Tickets API family (tickets). Tickets should be entered for requests that require an immediate response based on interruption or loss of your service. If the service loss or interruption was caused by Equinix, it will not incur any charges. If the issue was not caused by Equinix, there will be additional Smart Hands charges.", "tags": [ { "name": "tickets" }, { "name": "Tickets" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "code", "description": "Ticket Code.", "required": false, "schema": { "enum": [ "0000-0000", "0000-0001", "0000-0002", "0001-0000", "0001-0001", "0001-0002", "0001-0003", "0002-0000", "0002-0001", "0003-0000", "0003-0001", "0003-0002", "0003-0003", "0004-0000", "0005-0000", "0005-0001", "0007-0000", "0007-0001", "0007-0002", "0007-0003", "0007-0004", "0008-0000", "0008-0001", "0008-0002", "0008-0003", "0008-0004", "0008-0005", "0008-0006", "0008-0007", "0008-0008", "0008-0009", "0008-0010", "0012-0000", "0012-0001", "0012-0002", "0012-0003", "0012-0004", "0012-0005" ], "type": "string", "description": "Ticket Code.", "example": "0001-0000" } }, { "name": "description", "description": "Description of the trouble or issue.", "required": false, "schema": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "Description of the trouble or issue.", "example": "Description of the trouble or issue" } }, { "name": "primaryId", "description": "Primary reference identifier.", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Primary reference identifier.", "example": "AM0:000:00000" } }, { "name": "occurredDateTime", "description": "Date and time the issue occurred.", "required": false, "schema": { "type": "string", "description": "Date and time the issue occurred.", "format": "date-time", "example": "2020-05-22T19:23:51Z" } }, { "name": "secondaryId", "description": "Secondary reference identifier", "required": false, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Secondary reference identifier", "example": "AM0:000:00000:000" } }, { "name": "customerReferenceId", "description": "Customer Reference Number / External Reference Number.", "required": false, "schema": { "maxLength": 40, "minLength": 1, "type": "string", "description": "Customer Reference Number / External Reference Number.", "example": "External Reference Number" } }, { "name": "attachments", "description": "File(s) attached to the ticket. e.g. picture of broken device, scanned copy of bill or charge. To learn about including attachments in your request, see POST Attachments API.", "required": false, "schema": { "$ref": "#/components/schemas/Attachments_861931ea" } }, { "name": "contacts", "description": "List of persons who will be contacted for this ticket.", "required": false, "schema": { "type": "array", "items": { "anyOf": [ { "required": [ "registeredUsers", "type" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "type": "array", "items": { "type": "string", "example": "john_doe" }, "description": "Username of a registered user." }, "type": { "enum": [ "NOTIFICATION", "TECHNICAL" ], "type": "string", "description": "Type of contact.", "default": "NOTIFICATION" } }, "description": "Contact information of a registered user." }, { "required": [ "details", "name", "type" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "type": { "enum": [ "TECHNICAL" ], "type": "string", "description": "Type of contact.", "default": "TECHNICAL" }, "details": { "maxItems": 3, "minItems": 2, "type": "array", "items": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "enum": [ "PHONE", "MOBILE", "EMAIL" ], "type": "string", "description": "Communications Type.", "example": "PHONE" }, "value": { "type": "string", "description": "Value of communications type.", "example": "+1-4601231122" } }, "description": "Contact details." }, "description": "Communications Details." } }, "description": "Contact information of a non-registered contact." } ] }, "description": "List of persons who will be contacted for this ticket." } }, { "name": "details", "description": "List of additional details or requirements to support ticket resolution, depending on the trouble category you are facing.", "required": false, "schema": { "$ref": "#/components/schemas/Details_cea2fa4b" } } ], "result": { "name": "tickets_Create_a_TicketResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Create a Ticket", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "tickets_Retrieve_a_ticket", "summary": "Retrieve a ticket", "description": "This method retrieves a ticket by its ID for a user with permission to view this request.\n\nPart of the Equinix Tickets API family (tickets). Tickets should be entered for requests that require an immediate response based on interruption or loss of your service. If the service loss or interruption was caused by Equinix, it will not incur any charges. If the issue was not caused by Equinix, there will be additional Smart Hands charges.", "tags": [ { "name": "tickets" }, { "name": "Tickets" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Identifier of the ticket.", "required": true, "schema": { "maximum": 100.0, "minimum": 1.0, "type": "string", "description": "Identifier of the ticket." } } ], "result": { "name": "tickets_Retrieve_a_ticketResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "category": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Tickets Category.", "example": "Network" }, "subCategory": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Tickets Sub Category.", "example": "NE Connectivity Issue" }, "description": { "maxLength": 4000, "minLength": 10, "type": "string", "description": "Description of the trouble or issue.", "example": "Trouble Descriptions of network connections" }, "primaryId": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Primary reference identifier associated with the troubled asset, such as cage identifier.", "example": "AM0:000:00000" }, "occurredDateTime": { "type": "string", "description": "Date and time the issue occurred.", "format": "date-time" }, "id": { "maxLength": 20, "minLength": 10, "type": "string", "description": "Unique identifier of the ticket.", "example": "1-9808089098" }, "secondaryId": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Secondary reference identifier associated with the troubled asset.", "example": "AM0:000:00000:000" }, "customerReferenceId": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Customer Reference Number / External Reference Number.", "example": "External Reference Number" }, "resolutionDateTime": { "type": "string", "description": "The resolution date and time", "format": "date-time" }, "resolutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of an activity.", "example": "5-2000000000" }, "type": { "type": "string", "description": "type of event.", "example": "Trouble" }, "status": { "type": "string", "example": "Open - Dispatch" }, "description": { "type": "string", "description": "type of description.", "example": "Network issue" }, "price": { "type": "string", "description": "charges.", "example": "40.00" }, "hours": { "type": "string", "description": "hours", "example": "10" } }, "description": "Resolution events." }, "description": "Resolution Details." }, "status": { "enum": [ "RECEIVED", "IN_PROGRESS", "ON_HOLD", "CLOSED", "CANCELLED" ], "type": "string", "description": "The current status of the ticket." }, "details": { "$ref": "#/components/schemas/Details_cea2fa4b" }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Identifier of the note", "example": "1-ABCDE6IS" }, "createdDateTime": { "type": "string", "description": "The date and time the note was created.", "format": "date-time" }, "text": { "maxLength": 4000, "minLength": 5, "type": "string", "description": "The text of the note", "example": "Provide more details to understand the issue." }, "author": { "minLength": 5, "type": "string", "description": "Username or system name that created the note.", "example": "Equinix Support" }, "referenceId": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Reference identification related to troubleshooting activity.", "example": "5-2000000000" }, "type": { "enum": [ "CUSTOMER_QUERY", "CUSTOMER_NOTES", "TECHNICIAN_QUERY", "TECHNICIAN_NOTES" ], "type": "string", "description": "Type of notes.", "example": "TECHNICIAN_QUERY" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_9611d752" }, "description": "File(s) attached to the ticket. e.g. picture of broken device, scanned copy of bill or charge. To learn about including attachments in your request, see POST Attachments API." } } }, "description": "The note(s) that are associated to the ticket." }, "attachments": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_9611d752" }, "description": "File(s) attached to the ticket" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "registeredUser": { "type": "string", "description": "Username of a registered user.", "example": "john_doe" }, "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "type": { "enum": [ "ORDERING", "NOTIFICATION", "TECHNICAL" ], "type": "string", "description": "Communications type" }, "details": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "PHONE", "EMAIL" ], "type": "string", "description": "Communications Type.", "example": "PHONE" }, "value": { "type": "string", "description": "Value of communications type.", "example": "+1-4601231122" } }, "description": "Contact details." }, "description": "Communications Details." } }, "description": "Contact information." }, "description": "List of persons who will be contacted for this ticket." } }, "description": "A ticket is a record of an issue in a ticket management system.", "x-fastmcp-top-level-schema": "Tickets" } }, "x-mcp-annotations": { "title": "Retrieve a ticket", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "tickets_Update_a_ticket", "summary": "Update a Ticket", "description": "This method updates a ticket by its ID for a user with permission to view this request.\n\nPart of the Equinix Tickets API family (tickets). Tickets should be entered for requests that require an immediate response based on interruption or loss of your service. If the service loss or interruption was caused by Equinix, it will not incur any charges. If the issue was not caused by Equinix, there will be additional Smart Hands charges.", "tags": [ { "name": "tickets" }, { "name": "Tickets" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "id", "description": "Identifier of the ticket.", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Identifier of the ticket." } }, { "name": "contacts", "description": "List of persons who will be contacted for this ticket.", "required": true, "schema": { "maxItems": 1, "type": "array", "items": { "required": [ "registeredUsers", "type" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string", "example": "username@mail.com" }, "description": "Username of a registered user." }, "type": { "enum": [ "NOTIFICATION" ], "type": "string", "description": "Type of contact" } }, "description": "Contact information." }, "description": "List of persons who will be contacted for this ticket." } } ], "result": { "name": "tickets_Update_a_ticketResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update a Ticket", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "troubleticket_getLocation", "summary": "Get Locations(ibx, cage) Details for Trouble Ticket Based on Trouble Ticket Permission for User", "description": "This API returns list of permissible to ibx/cage/account/cabinets\n\nPart of the Equinix Trouble Ticket API family (troubleticket). If you are experiencing an issue that is impacting your service, please enter your information and submit a trouble ticket. If this issue is not impacting your service, please submit a Smart Hands request.", "tags": [ { "name": "troubleticket" }, { "name": "Troubleticket" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "detail", "description": "When enable this flag returns detailed permission with Cage & Cabinets.", "required": false, "schema": { "type": "boolean", "default": false, "description": "When enable this flag returns detailed permission with Cage & Cabinets." } }, { "name": "ibxs", "description": "CH1", "required": false, "schema": { "type": "string", "description": "CH1" } }, { "name": "cages", "description": "Eg: CH1:01:0101", "required": false, "schema": { "type": "string", "description": "Eg: CH1:01:0101" } } ], "result": { "name": "troubleticket_getLocationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "title": "Location", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "type": "string", "description": "Ibx Name", "example": "AM1" }, "cages": { "type": "array", "items": { "title": "Cage", "required": [ "cage" ], "type": "object", "properties": { "cage": { "type": "string", "description": "Cage or Suite", "example": "LD5:01:001MC3" }, "cageTypes": { "type": "array", "items": { "type": "string" }, "description": "Cage Types", "example": "Shared" }, "accounts": { "type": "array", "items": { "title": "Account", "required": [ "number", "name" ], "type": "object", "properties": { "number": { "type": "string", "description": "Account Number", "example": "136008" }, "name": { "type": "string", "description": "Name of Account", "example": "Service Corporation" }, "pricingEnabled": { "type": "boolean", "description": "Pricing enabled for account", "example": "false" }, "pricingEnforced": { "type": "boolean", "description": "Pricing enforced for account", "example": "false" }, "poTracking": { "type": "boolean", "description": "PO Tracking Account", "example": "false" }, "cabinets": { "type": "array", "items": { "title": "Cabinets", "type": "object", "properties": { "cabinet": { "type": "string", "description": "Cabinet Type", "example": "LD5:01:001MC3:0718" }, "cabinetType": { "type": "string", "description": "Cabinet Type" } } }, "description": "List of Cabinets" } } }, "description": "List of Accounts" } } }, "description": "List of cage" } } } } } } }, "x-mcp-annotations": { "title": "Get Locations(ibx, cage) Details for Trouble Ticket Based on Trouble Ticket Permission for User", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "troubleticket_getTroubleTicketType", "summary": "Get list of all Equinix Trouble Ticket Types", "description": "This operation will return all Equinix trouble ticket problems categories and corresponding details. API can be filtered by trouble ticket category.\n\nPart of the Equinix Trouble Ticket API family (troubleticket). If you are experiencing an issue that is impacting your service, please enter your information and submit a trouble ticket. If this issue is not impacting your service, please submit a Smart Hands request.", "tags": [ { "name": "troubleticket" }, { "name": "Troubleticket" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "category", "description": "To get results by trouble ticket category.", "required": false, "schema": { "enum": [ "Cross Connect", "Network", "Power", "Environment", "Hardware", "Security", "Managed Services", "Smartview" ], "type": "string", "description": "To get results by trouble ticket category." } } ], "result": { "name": "troubleticket_getTroubleTicketTypeResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "troubleTicketTypes": { "type": "array", "items": { "title": "TroubleTicket Type", "required": [ "category", "code", "description", "severity" ], "type": "object", "properties": { "category": { "type": "string", "description": "Type of trouble ticket." }, "code": { "type": "string", "description": "Code of trouble ticket. Use this code while placing Trouble Ticket Order" }, "description": { "type": "string", "description": "Description trouble ticket." }, "severity": { "type": "string", "description": "Severity of trouble ticket." }, "additionalDetails": { "type": "object", "properties": { "subCategories": { "type": "array", "items": { "type": "string" } }, "enabledIBXs": { "type": "array", "items": { "type": "string" } } } } }, "example": { "category": "Managed Services", "code": "ms01", "description": "Managed Firewall", "severity": "S1", "additionalDetails": { "subCategories": [ "Firewall_Issue", "VPN_Issue" ], "enabledIBXs": [ "DA1" ] } } } } } } }, "x-mcp-annotations": { "title": "Get list of all Equinix Trouble Ticket Types", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "troubleticket_placeTroubleTicketOrder", "summary": "If you are experiencing an issue that is impacting your service, please enter your information and submit a trouble ticket", "description": "If you are experiencing an issue that is impacting your service, please enter your information and submit a trouble ticket\n\nPart of the Equinix Trouble Ticket API family (troubleticket). If you are experiencing an issue that is impacting your service, please enter your information and submit a trouble ticket. If this issue is not impacting your service, please submit a Smart Hands request.", "tags": [ { "name": "troubleticket" }, { "name": "Troubleticket" }, { "name": "support" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "maxLength": 50, "type": "string", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page." } }, { "name": "ibxLocation", "description": "IBX, Cage, Accounts and Cabinet information", "required": false, "schema": { "title": "IBX Location", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "maxLength": 10, "minLength": 1, "type": "string", "example": "AM1" }, "cages": { "minItems": 1, "type": "array", "items": { "required": [ "cage", "accountNumber" ], "type": "object", "properties": { "cage": { "minLength": 1, "type": "string", "example": "AM1:01:001MC3" }, "accountNumber": { "minLength": 1, "type": "string", "example": "12345" }, "cabinets": { "type": "array", "items": { "type": "string", "example": "0102" } } } } } }, "description": "IBX, Cage, Accounts and Cabinet information" } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Ordering contact and notification contact are mandatory.Only one ordering contact, technical contact are allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal", "required": false, "schema": { "minLength": 2, "type": "array", "items": { "title": "Contact Info", "required": [ "contactType" ], "type": "object", "properties": { "contactType": { "enum": [ "TECHNICAL", "ORDERING", "NOTIFICATION" ], "type": "string", "description": "Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL", "example": "TECHNICAL" }, "userName": { "type": "string", "description": "User Name", "example": "kmo00re@abc.com" }, "name": { "type": "string", "description": "Technical Contact Name", "example": "David" }, "email": { "title": "emailDef", "maxLength": 100, "pattern": "^(([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$", "type": "string", "description": "Contact Email" }, "workPhoneCountryCode": { "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Primary Phone of the contact", "example": "+1" }, "workPhone": { "maxLength": 40, "type": "string", "description": "Primary Phone of the contact", "example": "111-111-1111" }, "workPhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "mobilePhoneCountryCode": { "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Mobile Phone of the contact", "example": "+1" }, "mobilePhone": { "maxLength": 40, "type": "string", "description": "Mobile Phone of the contact", "example": "111-111-1112" }, "mobilePhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "workPhoneTimeZone": { "maxLength": 40, "type": "string", "description": "Work Phone TimeZone", "example": "America/LosAngeles" }, "mobilePhoneTimeZone": { "maxLength": 40, "type": "string", "description": "Mobile Phone TimeZone", "example": "America/LosAngeles" } } }, "description": "Use this array to pass ordering contact, notification contacts and technical contact. Ordering contact and notification contact are mandatory.Only one ordering contact, technical contact are allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal" } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API", "required": false, "schema": { "type": "array", "items": { "title": "Attachment", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Attachement Id generated from Attachment Api", "example": "eb9ab7e9-3785-41e4-af24-112dff" }, "name": { "minLength": 1, "type": "string", "description": "Attachment file name. Please make sure to select an attachment name which is used while uploading via the attachment api.", "example": "eb9ab7e9-3785-41e4-af24-asfsa5424" } } }, "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API" } }, { "name": "serviceDetails", "description": "Use this object to pass all trouble related information.", "required": false, "schema": { "required": [ "incidentDateTime", "problemCode" ], "type": "object", "properties": { "incidentDateTime": { "type": "string", "description": "Date and time of received event (ISO Date)
Cannot be in the future. ", "format": "date-time", "example": "2017-04-05T12:00:00Z" }, "problemCode": { "enum": [ "cc01", "cc02", "cc03", "net01", "net02", "env01", "env02", "env03", "env04", "hdw01", "pwr01", "pwr02", "sec01", "sec02", "ms01", "ms04", "ms05", "ms06", "ms07", "ms08", "ms12", "ms13", "sv04", "sv02", "sv03", "sv05", "sv01" ], "type": "string", "description": "Code matching the problem description. For more details see API /orders/troubleticket/types" }, "serviceName": { "type": "string", "description": "Subcategory for managed services. It will be a mandatory field for managed services trouble ticket", "example": "Firewall Issue" }, "callFromCage": { "type": "boolean", "description": "Allow the technician to call from the cage.", "example": false }, "needSupportFromASubmarineCableStationEngineer": { "type": "boolean", "description": "This flag is only applicable to Submarine Cable IBXs", "example": false }, "additionalDetails": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Use this field to enter any information that applies to this trouble ticket request." } }, "description": "Use this object to pass all trouble related information." } } ], "result": { "name": "troubleticket_placeTroubleTicketOrderResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Trouble Ticket Response", "type": "object", "properties": { "OrderNumber": { "type": "string", "description": "Order Number", "example": "1-108124419634" } }, "x-fastmcp-top-level-schema": "troubleTicketResponse" } }, "x-mcp-annotations": { "title": "If you are experiencing an issue that is impacting your service, please enter your information and submit a trouble ticket", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "unifiednotification_getNotifications", "summary": "Search notification", "description": "Search events by search criteria\n\nPart of the Equinix Notifications API family (unifiednotification). The notifications API will return email notifications for different categories, such as orders, IBX maintenance announcements, incidents and advisories. Please check the Category, Type, and ProductType schemas for the allowed lists of values to perform a search request.", "tags": [ { "name": "unifiednotification" }, { "name": "Events" }, { "name": "notifications" } ], "paramStructure": "by-name", "params": [ { "name": "filter", "required": false, "schema": { "title": "Filter the event", "type": "object", "properties": { "category": { "minItems": 1, "type": "array", "items": { "title": "Category", "enum": [ "GENERAL", "INCIDENT", "MAINTENANCE", "ADVISORY" ], "type": "string", "description": "Category of events.", "default": "GENERAL" } }, "type": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Type_cea3cefc" } }, "notificationNumber": { "minItems": 1, "type": "array", "items": { "type": "string", "example": "1-123894189299" } }, "accountNumber": { "minItems": 1, "type": "array", "items": { "type": "string", "example": "596697" } }, "createdDateTime": { "minItems": 1, "type": "array", "items": { "type": "string", "example": "2024-01-31T16:00:00.000Z" } } } } }, { "name": "sort", "required": false, "schema": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "createdDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "createdDateTime" } } } } }, { "name": "pagination", "description": "Pagination request information", "required": false, "schema": { "type": "object", "properties": { "offset": { "minimum": 0.0, "type": "integer", "description": "Index of the first element.", "default": 0 }, "limit": { "minimum": 1.0, "type": "integer", "description": "Number of elements to be requested per page. Number must be between 1 and 100, and the default is 25.", "default": 25 } }, "description": "Pagination request information" } } ], "result": { "name": "unifiednotification_getNotificationsResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "notificationNumber", "type", "summary" ], "type": "object", "properties": { "notificationNumber": { "type": "string", "description": "Notification reference number.", "example": "1-123894189299" }, "category": { "title": "Category", "enum": [ "GENERAL", "INCIDENT", "MAINTENANCE", "ADVISORY" ], "type": "string", "description": "Category of events.", "default": "GENERAL" }, "type": { "$ref": "#/components/schemas/Type_cea3cefc" }, "productTypes": { "type": "array", "items": { "enum": [ "ACCESSORIES", "BI_CLOUD", "BI_VLA", "BOOK_CONFERENCEROOM", "CABINET", "CAGE", "EQUINIX_FABRIC", "CLOUD_IX", "CROSS_CONNECT", "DEINSTALL", "EQUINIX_CONNECT", "EQUINIX_CONNECT_PORT", "ETHERNET_EXCHANGE", "EXPEDITE", "HANDSCAN", "INBOUND_SHIPMENT", "INTERNET_EXCHANGE", "INTERNET_EXCHANGE_PORT", "INTER_METRO_CONNECT", "MANAGEMENT_ACCESS", "METRO_CONNECT", "MOBILITY_EXCHANGE", "NETWORK_TIMING", "OTHER", "OTHER_SERVICES", "OUTBOUND_SHIPMENT", "POWER", "SITE_VISIT", "SMART_HANDS", "SMART_HANDS_MONTHLY_PLAN", "SMART_HANDS_ANNUAL_PLAN", "TOUR_REQUEST", "TROUBLE_TICKET", "VMMR_SDH", "VOIP", "UNKNOWN", "NETWORK_EDGE", "FABRIC", "PRECISION_TIME" ], "type": "string", "example": "SMART_HANDS" }, "description": "Product types associated with the given order notification." }, "ibxs": { "type": "array", "items": { "type": "string" }, "description": "IBX(s) associated with the notification.", "example": [ "LD8" ] }, "createdDateTime": { "type": "string", "description": "Time when the notification was sent.", "format": "date-time", "example": "2017-11-28T17:41:56.218Z" }, "summary": { "type": "string", "description": "Notification summary.", "example": "Your Equinix Order # 1-204456332435 – Expired/Canceled order lines" }, "status": { "title": "Status", "enum": [ "CANCELLED", "COMPLETED", "EXPEDITE", "EXPIRED_CANCELLED", "EXTENDED", "IN_PROGRESS", "MODIFIED", "NEW", "OTHER", "RECEIVED", "REQUIRE_APPROVAL", "RESCHEDULED", "RESOLVED", "SCHEDULED", "SHIPMENT_NOTIFICATION", "UPDATED", "FAILED", "PROVISIONED", "DEPROVISIONED" ], "type": "string", "description": "Event/Notification Status.If no status found none will be returned", "example": "RESOLVED" }, "contacts": { "type": "array", "items": { "title": "NotificationContact", "required": [ "firstName", "lastName", "email" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION" ], "type": "string", "description": "Type of Notification Contact", "example": "NOTIFICATION" }, "firstName": { "type": "string", "description": "First name.", "example": "John" }, "lastName": { "type": "string", "description": "Last name.", "example": "Doe" }, "details": { "type": "array", "items": { "title": "NotificationContactDetails", "type": "object", "properties": { "type": { "type": "string", "description": "Name of the type", "example": "EMAIL" }, "value": { "type": "string", "description": "The value of the corresponding type", "example": "johndoe@acme.com" } } } } }, "description": "Order notification contact." }, "description": "Notification recipient list, if any." }, "additionalInfo": { "type": "array", "items": { "title": "AdditionalInfoAttribute", "type": "object", "properties": { "key": { "type": "string", "description": "Name of the key", "example": "START_DATETIME" }, "value": { "type": "string", "description": "The value of the corresponding key", "example": "2017-11-28T17:41:56.218013Z" } } }, "description": "Additional info, if any. Available fields: SUPPORT_PLAN_PERCENTAGE, ACCOUNT_NAME, ACCOUNT_NUMBER, START_DATETIME, END_DATETIME, PRIORITY, IS_GLOBAL_NOTIFICATION" } } }, "description": "POST Event Search" }, "pagination": { "required": [ "limit", "total" ], "type": "object", "properties": { "offset": { "minimum": 0.0, "type": "integer", "description": "Index of the first item returned in the response. The default is 0.", "default": 0 }, "limit": { "minimum": 0.0, "type": "integer", "description": "Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 25.", "default": 25 }, "total": { "minimum": 0.0, "type": "integer", "description": "Total number of elements returned." }, "next": { "type": "string", "description": "The offset value relative to the next item in the response.", "example": "20" }, "previous": { "type": "string", "description": "The offset value relative to the previous item in the response.", "example": "30" } }, "description": "Pagination response information" } }, "x-fastmcp-top-level-schema": "EventSearchResponse" } }, "x-mcp-annotations": { "title": "Search notification", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "workflow__list_ne_metros", "summary": "Retrieve Network Edge metros", "description": "Retrieve Network Edge metros", "tags": [ { "name": "workflows" } ], "paramStructure": "by-name", "params": [ { "name": "inputs_json", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "result": { "name": "workflow__list_ne_metrosResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "workvisit_Schedule_Work_Visit_Services", "summary": "Schedule Work Visit Services", "description": "This method creates a work visit request that grants IBX visitors access for up to two weeks. This can only be done by a user with work visit request permission.\n\nPart of the Equinix Work Visit API family (workvisit). Schedule and manage work visits (on-site access to Equinix IBX data centers).", "tags": [ { "name": "workvisit" }, { "name": "Work Visit" }, { "name": "colocation" }, { "name": "site-access" } ], "paramStructure": "by-name", "params": [ { "name": "description", "description": "Description of the Work Visit", "required": false, "schema": { "maxLength": 4000, "minLength": 10, "type": "string", "description": "Description of the Work Visit", "example": "Monthly Routine check" } }, { "name": "customerReferenceId", "description": "Customer Reference Number / External Reference Number", "required": false, "schema": { "maxLength": 40, "minLength": 1, "type": "string", "description": "Customer Reference Number / External Reference Number", "example": "048837d6-4cd8-401f-ba41-a4ac015c3f3e" } }, { "name": "purchaseOrder", "description": "Purchase Order", "required": false, "schema": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "EXEMPTED", "NEW", "EXISTING" ], "type": "string", "description": "Type of the Purchase Order", "example": "EXISTING" }, "number": { "type": "string", "description": "Purchase order number is applicable when `type` is `EXISTING` or `NEW`", "example": 1091238010 }, "amount": { "type": "number", "description": "This is only applicable when `type` is `NEW`.", "example": "2020" }, "startDate": { "type": "string", "description": "This is only applicable when `type` is `NEW`.", "format": "date", "example": "2020-05-22" }, "endDate": { "type": "string", "description": "This is only applicable when `type` is `NEW`.", "format": "date", "example": "2021-05-22" }, "attachmentId": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Attachment ID of Purchase Order document.", "example": "8d0bef9c-cca9-11ea-87d0-0242ac130003" } }, "description": "Purchase Order" } }, { "name": "attachments", "description": "File(s) attached to the Work visit. To learn about including attachments in your request, see POST Attachments API.", "required": false, "schema": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_3a0c3cd7" }, "description": "File(s) attached to the Work visit. To learn about including attachments in your request, see POST Attachments API." } }, { "name": "contacts", "description": "The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, specify the Technical contact and Notification contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users).", "required": false, "schema": { "type": "array", "items": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/ContactsItem_78ce6c57" }, { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "TECHNICAL" ], "type": "string", "description": "Type of contact.", "default": "NOTIFICATION" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Contact's availability to receive calls.", "default": "ANYTIME" }, "timezone": { "$ref": "#/components/schemas/Timezone_83d81d7f" } }, "description": "Contact information of a registered user. Ensure that the user status of this contact is approved, active or locked." } ] }, { "allOf": [ { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "TECHNICAL" ], "type": "string", "description": "Type of contact.", "default": "TECHNICAL" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Contact's availability to receive calls.", "default": "ANYTIME" }, "timezone": { "$ref": "#/components/schemas/Timezone_83d81d7f" } } }, { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "details": { "maxItems": 2, "minItems": 0, "type": "array", "items": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "enum": [ "MOBILE", "EMAIL" ], "type": "string", "description": "Customer's email or mobile number depending on communications type", "example": "MOBILE" }, "value": { "type": "string", "description": "Value of related `type`. Input email address when type is of `EMAIL` and mobile number for type `MOBILE`. Prefix phone number with country code (i.e +1 for US) if you are using mobile number." } }, "description": "Contact details." }, "description": "Reference of the related party, could be a party reference or a party role reference" } }, "description": "Contact information of a non-registered contact, including contact details." } ], "description": "Contact information of a registered user. Ensure that the user status of this contact is approved, active or locked." } ] }, "description": "The ordering user is the default Technical and Notification contacts. If you would like to provide a different Technical contact and/or additional Notification contacts, specify the Technical contact and Notification contact(s) details. There can only be 1 Technical contact (registered user or not), but there can be more than 1 Notification contacts (registered users)." } }, { "name": "details", "required": false, "schema": { "required": [ "cages", "visitStartDateTime", "visitEndDateTime", "visitors" ], "allOf": [ { "type": "object", "properties": { "cages": { "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID of the cage that is scheduled for work visit", "example": "DC2:01:123456" }, "accountNumber": { "type": "string", "description": "Customer account number that is linked to the cage.", "example": "1234567890" }, "cabinetId": { "type": "string", "description": "The unique ID of cabinet. Provide cabinet ID if you want to limit access to specific cabinets.", "example": "DC2:01:123456:0101" } } } } } }, { "type": "object", "properties": { "openCabinet": { "type": "boolean", "description": "Equinix Technicial to help to open the cage and an additional charge incured by the customer", "default": false }, "visitStartDateTime": { "type": "string", "format": "date-time" }, "visitEndDateTime": { "type": "string", "format": "date-time" }, "visitors": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ContactsItem_78ce6c57" }, { "required": [ "firstName", "lastName", "companyName" ], "type": "object", "properties": { "firstName": { "maxLength": 30, "type": "string", "description": "First name of the visitor.", "example": "John" }, "lastName": { "maxLength": 30, "type": "string", "description": "Last name of the visitor.", "example": "Doe" }, "companyName": { "maxLength": 80, "type": "string", "description": "Name of the company.", "example": "Acme Corporation" }, "details": { "maxItems": 2, "minItems": 0, "type": "array", "items": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "enum": [ "MOBILE", "EMAIL" ], "type": "string", "description": "Customer's email or mobile number depending on communications type", "example": "MOBILE" }, "value": { "type": "string", "description": "Value of related `type`. Input email address when type is of `EMAIL` and mobile number for type `MOBILE`. Prefix phone number with country code (i.e +1 for US) if you are using mobile number.", "example": "+1-4601231122" } }, "description": "Contact details." }, "description": "Reference of the related party, could be a party reference or a party role reference" } }, "description": "Contact information of a non-registered contact, including contact details." } ] }, "description": "The maximum limit for non registered visitors is 50" } } } ] } } ], "result": { "name": "workvisit_Schedule_Work_Visit_ServicesResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Schedule Work Visit Services", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "workvisit_Update_a_work_visit_order", "summary": "Update a work visit order", "description": "This method modifies work visit details, such as contacts and visiting information, for a user with work visit request permission.\n\nPart of the Equinix Work Visit API family (workvisit). Schedule and manage work visits (on-site access to Equinix IBX data centers).", "tags": [ { "name": "workvisit" }, { "name": "Work Visit" }, { "name": "colocation" }, { "name": "site-access" } ], "paramStructure": "by-name", "params": [ { "name": "orderId", "description": "Identifier of the work visit orders", "required": true, "schema": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Identifier of the work visit orders" } }, { "name": "contacts", "required": false, "schema": { "maxItems": 1, "type": "array", "items": { "required": [ "registeredUsers", "type" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string", "example": "john_doe1" }, "description": "Username of registered user" }, "type": { "enum": [ "NOTIFICATION" ], "type": "string", "description": "Type of contact" } }, "description": "Contact information of a registered user. Ensure that the user status of this contact is approved or active." } } }, { "name": "details", "required": false, "schema": { "allOf": [ { "type": "object", "properties": { "visitStartDateTime": { "type": "string", "description": "Requested start date and time of the work visit in UTC timezone in ISO 8601 format", "format": "date-time", "example": "2020-12-17'T'09:15:44Z" }, "visitEndDateTime": { "type": "string", "description": "Requested end date and time of the work visit in UTC timezone in ISO 8601 format", "format": "date-time", "example": "2020-12-18'T'09:15:44Z" }, "openCabinet": { "type": "boolean", "description": "This is an additional request for Equinix to open your secure cabinet during the work visit. When `true`, Equinix staff will open cabinet during work visit.", "default": false } } } ] } } ], "result": { "name": "workvisit_Update_a_work_visit_orderResult", "schema": { "$ref": "#/components/schemas/CallToolResult" } }, "x-mcp-annotations": { "title": "Update a work visit order", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } }, { "name": "workvisit_getLocation", "summary": "Get Work visit Locations", "description": "Deprecated: this operation may be removed. Prefer a non-deprecated alternative where one exists.\n\nThe Get work visit locations API returns all IBXs and related cages where the user has 'IBX Access Services Request' permission. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.\n\nPart of the Equinix Work Visit API family (workvisit). Schedule and manage work visits (on-site access to Equinix IBX data centers).", "tags": [ { "name": "workvisit" }, { "name": "Workvisit" }, { "name": "colocation" }, { "name": "deprecated" }, { "name": "site-access" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "detail", "description": "When enable this flag returns detailed permission with Cage & Cabinets.", "required": false, "schema": { "type": "boolean", "default": false, "description": "When enable this flag returns detailed permission with Cage & Cabinets." } }, { "name": "ibxs", "description": "IBX Filter. Example: AM1, AM2", "required": false, "schema": { "type": "string", "description": "IBX Filter. Example: AM1, AM2" } }, { "name": "cages", "description": "Cage Filter. Example: AM1:0G:00EQ", "required": false, "schema": { "type": "string", "description": "Cage Filter. Example: AM1:0G:00EQ" } } ], "result": { "name": "workvisit_getLocationResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "type": "object", "properties": { "locations": { "type": "array", "items": { "title": "Location", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "type": "string", "description": "Ibx Name", "example": "AM1" }, "cages": { "type": "array", "items": { "title": "Cage", "required": [ "cage" ], "type": "object", "properties": { "cage": { "type": "string", "description": "Cage", "example": "AM1:0G:00E" }, "cageTypes": { "type": "array", "items": { "type": "string" }, "description": "Cage Types", "example": "Shared" }, "accounts": { "type": "array", "items": { "title": "Account", "required": [ "number", "name" ], "type": "object", "properties": { "number": { "type": "string", "description": "Account Number", "example": "136008" }, "name": { "type": "string", "description": "Name of Account", "example": "Service Corporation" }, "isCreditHold": { "type": "boolean", "description": "Is credit Hold account", "example": "false" }, "isPOBearing": { "type": "boolean", "description": "Is PO Bearing account", "example": "false" }, "cabinets": { "type": "array", "items": { "title": "Cabinets", "type": "object", "properties": { "cabinet": { "type": "string", "description": "Cabinet Type", "example": "LD5:01:001MC3:0718" }, "cabinetType": { "type": "string", "description": "Cabinet Type" } } }, "description": "List of Cabinets" } } }, "description": "List of Accounts" } } }, "description": "List of cage" } } } } } } }, "x-mcp-annotations": { "title": "Get Work visit Locations", "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": true } }, { "name": "workvisit_workVisitOrder", "summary": "Schedule Work Visit", "description": "Deprecated: this operation may be removed. Prefer a non-deprecated alternative where one exists.\n\nThe Post work visit API creates a work visit request to grant IBX visitors access for up to two weeks. This can only be done under a user with 'IBX Access Services Request' permission.\n\nPart of the Equinix Work Visit API family (workvisit). Schedule and manage work visits (on-site access to Equinix IBX data centers).", "tags": [ { "name": "workvisit" }, { "name": "Workvisit" }, { "name": "colocation" }, { "name": "deprecated" }, { "name": "site-access" } ], "paramStructure": "by-name", "params": [ { "name": "Authorization", "description": "Specify the Access token with prefix 'Bearer'.", "required": true, "schema": { "description": "Specify the Access token with prefix 'Bearer'." } }, { "name": "contacts", "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. Only username and contactType are valid for ordering and notification contacts, all other attributes will be ignored.

Technical contact is optional. workPhoneCountryCode, workPhone and workPhonePrefToCall attributes are mandatory for Technical Contact(when Provided).

If notification contact is not available to pass, please use ordering contact as notification contact also.
", "required": false, "schema": { "minItems": 2, "type": "array", "items": { "title": "Contact Info", "required": [ "contactType" ], "type": "object", "properties": { "contactType": { "enum": [ "TECHNICAL", "ORDERING", "NOTIFICATION" ], "type": "string", "description": "Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL", "example": "TECHNICAL" }, "userName": { "type": "string", "description": "User Name", "example": "kmo00re@abc.com" }, "name": { "pattern": "^[\\s.]*([^\\s.][\\s.]*){0,100}$", "type": "string", "description": "Technical Contact Name", "example": "David" }, "email": { "title": "emailDef", "maxLength": 100, "pattern": "^(([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$", "type": "string", "description": "Contact Email" }, "workPhoneCountryCode": { "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Primary Phone of the contact", "example": "+1" }, "workPhone": { "pattern": "^[0-9\\.\\-() ]{2,40}(?:(x|ext).+)?$", "type": "string", "description": "Primary Phone of the contact", "example": "111-111-1111" }, "workPhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "mobilePhoneCountryCode": { "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Mobile Phone of the contact", "example": "+1" }, "mobilePhone": { "pattern": "^[0-9\\.\\-() ]{2,40}(?:(x|ext).+)?$", "type": "string", "description": "Mobile Phone of the contact", "example": "111-111-1112" }, "mobilePhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "workPhoneTimeZone": { "$ref": "#/components/schemas/TimeZoneEnum" }, "mobilePhoneTimeZone": { "$ref": "#/components/schemas/TimeZoneEnum" } } }, "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal. Only username and contactType are valid for ordering and notification contacts, all other attributes will be ignored.

Technical contact is optional. workPhoneCountryCode, workPhone and workPhonePrefToCall attributes are mandatory for Technical Contact(when Provided).

If notification contact is not available to pass, please use ordering contact as notification contact also.
", "example": [ { "contactType": "ORDERING", "userName": "jondoe@test.com" }, { "contactType": "NOTIFICATION", "userName": "jondoe@test.com" }, { "contactType": "TECHNICAL", "name": "John Doe", "workPhone": "1111111", "workPhonePrefToCall": "ANYTIME", "mobilePhone": "1111111", "mobilePhonePrefToCall": "ANYTIME" } ] } }, { "name": "customerReferenceNumber", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "required": false, "schema": { "maxLength": 50, "minLength": 1, "type": "string", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "example": "cust-ref-123" } }, { "name": "ibxLocation", "required": false, "schema": { "title": "IBX Location", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "maxLength": 10, "minLength": 1, "type": "string", "example": "AM1" }, "cages": { "minItems": 1, "type": "array", "items": { "required": [ "cage", "accountNumber" ], "type": "object", "properties": { "cage": { "minLength": 1, "type": "string", "example": "AM1:0G:00E" }, "cabinets": { "type": "array", "items": { "type": "string", "example": "0101" } }, "accountNumber": { "minLength": 1, "type": "string", "example": "12345" } } } } } } }, { "name": "attachments", "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API", "required": false, "schema": { "maxItems": 5, "type": "array", "items": { "title": "Attachment", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Attachement Id", "example": "eb9ab7e9-3785-41e4-af24-74b8dc37b254" }, "name": { "minLength": 1, "type": "string", "description": "Attachment file name", "example": "uecp-finance-service-api-swagger.yml" } } }, "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API" } }, { "name": "serviceDetails", "required": false, "schema": { "title": "Service Detail", "required": [ "visitors", "schedule" ], "type": "object", "properties": { "additionalDetails": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Any additional information related to work visit", "example": "Additional notes related to order" }, "schedule": { "required": [ "startDateTime", "endDateTime" ], "type": "object", "properties": { "startDateTime": { "type": "string", "description": "Start Date Time (ISO Date)
Cannot Past Date.", "format": "date-time", "example": "2017-04-05T10:00:00Z" }, "endDateTime": { "type": "string", "description": "End Date Time (ISO Date)
Cannot Past Date.", "format": "date-time", "example": "2017-04-05T12:00:00Z" } }, "description": "A work visit ticket is active for up to two weeks. For durations longer than two weeks, request security access order" }, "visitors": { "minLength": 1, "maxItems": 50, "minItems": 1, "type": "array", "items": { "title": "Visitor", "type": "object", "properties": { "userName": { "type": "string", "description": "Equinix registered username. when username passed other attributes for vistor model will be ignored." }, "firstName": { "maxLength": 30, "type": "string", "example": "John" }, "lastName": { "maxLength": 30, "type": "string", "example": "Doe" }, "company": { "maxLength": 80, "type": "string", "example": "Test Organization" }, "email": { "pattern": "^(([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$", "type": "string", "description": "Visitor Email", "example": "abc@xyz.com" }, "mobilePhoneCountryCode": { "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Mobile country code of the visitor", "example": "+1" }, "mobilePhone": { "maxLength": 40, "pattern": "^[0-9(]+[0-9-.()\\s]+[0-9]+$", "type": "string", "description": "Phone number allowed special characters are -.() and spaces. First character should either be numeric digit or '('. Last character should only be a numeric digit.", "example": "111-111-1112" } }, "description": "Vistor Information, either username or (firstname,lastname,company) are mandatory" }, "example": [ { "firstName": "John", "lastName": "Doe", "company": "Test Organization", "email": "abc@xyz.com", "mobilePhoneCountryCode": 1, "mobilePhone": "111-111-1112" }, { "userName": "testuser@test.com" } ] }, "openCabinet": { "type": "boolean", "default": "false" }, "supervisionRequired": { "type": "boolean", "default": "false" } } } } ], "result": { "name": "workvisit_workVisitOrderResult", "description": "structuredContent of the tool's CallToolResult.", "schema": { "title": "Work Visit Order Item Response", "type": "object", "properties": { "successes": { "type": "array", "items": { "type": "object", "properties": { "ibxLocation": { "type": "object", "properties": { "ibx": { "type": "string" }, "cageDetails": { "type": "array", "items": { "type": "object", "properties": { "cage": { "type": "string" }, "accountNumber": { "type": "string" }, "cabinets": { "type": "array", "items": { "type": "object", "properties": { "cabinet": { "type": "string" } } } } } } } } }, "response": { "type": "object", "properties": { "OrderNumber": { "type": "string" } } } } } } }, "x-fastmcp-top-level-schema": "orderItemResponse" } }, "x-mcp-annotations": { "title": "Schedule Work Visit", "readOnlyHint": false, "idempotentHint": false, "openWorldHint": true } } ], "components": { "schemas": { "ASide_657eaec5": { "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_04efc84a" } }, "description": "A-Side configuration. Always a patch panel port from your cage.\n" }, "ASide_9935d2e1": { "type": "object", "properties": { "accessPointSelectors": { "$ref": "#/components/schemas/AccessPointSelectors" } }, "description": "Connection link protocol,virtual device or network configuration" }, "ASide_cc9f4f57": { "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_d8b2b563" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "Equinix IBX data centre code.", "example": "SV1" } }, "description": "Destination location for BMMR and REMOTE connections." } }, "description": "Originating end as provisioned, with the demarcation point and IBX location." }, "ASide_cdc3f780": { "type": "object", "properties": { "serviceToken": { "$ref": "#/components/schemas/ServiceToken" }, "accessPoint": { "$ref": "#/components/schemas/AccessPoint_22dada48" }, "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Any additional information, which is not part of connection metadata or configuration" } }, "description": "Connection configuration object for each side of multi-segment connection" }, "ASide_d11a90e8": { "required": [ "connectorType", "patchPanel", "portA" ], "type": "object", "properties": { "circuitId": { "maxLength": 200, "type": "string", "description": "Optional, customer-defined Cross Connect instance identifier.", "example": "34234535" }, "connectorType": { "type": "string", "description": "Patch panel connector type.", "example": "ST" }, "patchPanel": { "$ref": "#/components/schemas/PatchPanel_1ebf84a5" }, "portA": { "type": "integer", "description": "Port A", "format": "int32", "example": 12 }, "portB": { "type": "integer", "description": "Port B", "format": "int32", "example": 13 } } }, "ASide_df14dd5d": { "required": [ "connectorType", "patchPanelId", "portA" ], "type": "object", "properties": { "connectorType": { "type": "string", "description": "Patch panel connector type.", "example": "ST" }, "circuitId": { "maxLength": 200, "type": "string", "description": "Optional, customer-defined Cross Connect instance identifier.", "example": "34234535" }, "patchPanelId": { "type": "string", "description": "Patch panel identifier.", "example": "CP:0218:0102:13008148" }, "portA": { "type": "integer", "description": "Port A", "format": "int32", "example": 12 }, "portB": { "type": "integer", "description": "Port B", "format": "int32", "example": 13 } } }, "ASide_dfb7151e": { "type": "object", "properties": { "accessPoint": { "$ref": "#/components/schemas/AccessPoint_c567d6e1" } } }, "ASide_e75667ae": { "allOf": [ { "$ref": "#/components/schemas/CrossConnectASideRequest" } ], "description": "A-Side connection details." }, "AccessPointSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/AccessPointSelectorsItem" }, "description": "List of AccessPointSelectors" }, "AccessPointSelectorsItem": { "type": "object", "properties": { "type": { "enum": [ "COLO", "VD", "NETWORK" ], "type": "string", "description": "Type of Access point" }, "hideAssetInfo": { "type": "boolean" }, "port": { "$ref": "#/components/schemas/Port_9a46e395" }, "linkProtocol": { "$ref": "#/components/schemas/LinkProtocol" }, "virtualDevice": { "$ref": "#/components/schemas/VirtualDevice_d244906a" }, "interface": { "$ref": "#/components/schemas/Interface_3d0e58e1" }, "network": { "$ref": "#/components/schemas/Network_16ae54fb" } }, "description": "List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability." }, "AccessPointTypeConfigs": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/AccessPointTypeConfigsItem_167832e2" } }, "AccessPointTypeConfigsItem_167832e2": { "type": "object", "description": "Access Point Type", "anyOf": [ { "$ref": "#/components/schemas/AccessPointTypeConfigsItem_2c177323" }, { "$ref": "#/components/schemas/AccessPointTypeConfigsItem_30771099" } ] }, "AccessPointTypeConfigsItem_2c177323": { "required": [ "type" ], "type": "object", "properties": { "uuid": { "type": "string" }, "type": { "enum": [ "VD", "COLO" ], "type": "string", "description": "Access point type" }, "supportedBandwidths": { "type": "array", "items": { "type": "integer", "description": "speed in Mbps", "example": 50 } }, "allowRemoteConnections": { "type": "boolean", "description": "Setting to allow or prohibit remote connections to the service profile.", "default": false, "example": true }, "allowCustomBandwidth": { "type": "boolean", "description": "Setting to enable or disable the ability of the buyer to customize the bandwidth.", "default": false, "example": true }, "bandwidthAlertThreshold": { "type": "number", "description": "percentage of port bandwidth at which an allocation alert is generated - missing on wiki." }, "allowBandwidthAutoApproval": { "type": "boolean", "description": "Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.", "default": false }, "allowBandwidthUpgrade": { "type": "boolean", "description": "Availability of a bandwidth upgrade. The default is false." }, "linkProtocolConfig": { "$ref": "#/components/schemas/LinkProtocolConfig" }, "enableAutoGenerateServiceKey": { "type": "boolean", "description": "for verizon only." }, "connectionRedundancyRequired": { "type": "boolean", "description": "Mandate redundant connections", "default": false, "example": true }, "selectiveRedundancy": { "type": "boolean", "description": "Optional redundant connections", "default": false, "example": true }, "apiConfig": { "$ref": "#/components/schemas/ApiConfig" }, "connectionLabel": { "type": "string", "description": "custom name for \"Connection\"" }, "authenticationKey": { "type": "object", "properties": { "required": { "type": "boolean", "default": false, "example": true }, "label": { "type": "string", "example": "Service Key" }, "description": { "type": "string", "example": "description for the authentication key" } }, "description": "Authentication Key Support and Customization" }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "description": "Colo Access Point Type" }, "AccessPointTypeConfigsItem_30771099": { "required": [ "type" ], "type": "object", "properties": { "uuid": { "type": "string" }, "type": { "enum": [ "VD", "COLO" ], "type": "string", "description": "Access point type" }, "supportedBandwidths": { "type": "array", "items": { "type": "integer", "description": "speed in Mbps", "example": 50 } }, "allowRemoteConnections": { "type": "boolean", "description": "Allow remote connections to Service Profile", "example": true }, "allowCustomBandwidth": { "type": "boolean", "example": true } }, "additionalProperties": false, "description": "VirtualDevice Access Point Type" }, "AccessPoint_22dada48": { "type": "object", "properties": { "type": { "enum": [ "VD", "VG", "SP", "IGW", "COLO", "SUBNET", "CLOUD_ROUTER", "NETWORK", "METAL_NETWORK", "VPIC_INTERFACE", "APP_LINK", "IC" ], "type": "string", "description": "Access point type" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "port": { "$ref": "#/components/schemas/Port_f3a76199" }, "profile": { "$ref": "#/components/schemas/Profile" }, "router": { "$ref": "#/components/schemas/Router_6252121a" }, "linkProtocol": { "$ref": "#/components/schemas/LinkProtocol" }, "virtualDevice": { "$ref": "#/components/schemas/VirtualDevice_90030e51" }, "interface": { "$ref": "#/components/schemas/Interface_ddd240fb" }, "network": { "$ref": "#/components/schemas/Network_f1775ec0" }, "environment": { "$ref": "#/components/schemas/EnvironmentsItem" }, "sellerRegion": { "type": "string", "description": "Access point seller region" }, "peeringType": { "enum": [ "PRIVATE", "MICROSOFT", "PUBLIC", "MANUAL" ], "type": "string", "description": "Access point peering type" }, "authenticationKey": { "type": "string", "description": "Access point authentication key" }, "activationKey": { "type": "string", "description": "Access point activation key" }, "providerConnectionId": { "type": "string", "description": "Provider assigned Connection Id" }, "virtualNetwork": { "type": "object", "properties": { "href": { "type": "string", "description": "The Canonical URL at which the resource resides.", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned Virtual Network identifier", "format": "uuid" } }, "description": "Virtual Network Information" }, "interconnection": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Equinix Metal Interconnection", "format": "uuid" } }, "description": "Metal Interconnection" }, "role": { "enum": [ "LEAF", "ROOT" ], "type": "string", "description": "E-Tree network connection role" }, "productOffering": { "$ref": "#/components/schemas/ProductOffering" }, "bandwidthCommit": { "maximum": 100000.0, "minimum": 0.0, "type": "integer", "description": "Bandwidth commit in Mbps" }, "providerIdentifier": { "type": "string", "description": "Provider identifier" }, "address": { "$ref": "#/components/schemas/Address" } }, "description": "Access point object" }, "AccessPoint_c567d6e1": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "COLO", "VD", "SP" ], "type": "string", "example": "COLO" }, "name": { "type": "string", "example": "Single-Port-Internet-Access" }, "description": { "type": "string", "example": "Highly available access to the internet primary port" }, "location": { "$ref": "#/components/schemas/Location_ed4243bb" }, "port": { "$ref": "#/components/schemas/Port_fbde9407" }, "linkProtocol": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "DOT1Q", "QINQ" ], "type": "string", "description": "encapsulation type", "example": "DOT1Q" } } }, "virtualDevice": { "$ref": "#/components/schemas/VirtualDevice_d2a8a3ae" } } }, "AccessPolicyId_0e5d0ba1": { "description": "\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "anyOf": [ { "$ref": "#/components/schemas/AccessPolicyId_e60f61ab" }, { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } ] }, "AccessPolicyId_542bc819": { "type": "string", "pattern": "^ern:(?P[^:]{1,50}):(?P[^:/]{1,50}/[^:/]{1,50}):(?P[^:]{1,50}):(?P[^:]{1,36}):(?P[^:]{1,50}):(?P[^:]{1,50})$", "description": "Equinix resource name, a universally unique identifier for a resource across all clouds, regions, and\n services. Formatted as\n \"ern:<cloudId>:<serviceId>:<regionId>:<projectId>:<resourceType>:<resourceId>\".", "example": "ern:eqix:equinix/sts:global:abc-123:SomeType:res-id" }, "AccessPolicyId_80cae0a0": { "description": "Uniquely identifies an access policy within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "anyOf": [ { "type": "string", "pattern": "^accesspolicy:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies an access policy within a project.", "example": "accesspolicy:my-policy" }, { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } ] }, "AccessPolicyId_e60f61ab": { "anyOf": [ { "type": "string", "pattern": "^accesspolicy:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies an access policy within a project.", "example": "accesspolicy:my-policy" }, { "type": "string", "pattern": "^managedpolicy:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed policy globally.", "example": "managedpolicy:my-policy" } ] }, "Access_createPolicyMaskResult": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Result_b74ae1ff" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true }, "Access_createRoleAssignmentResult": { "properties": { "roleAssignmentId": { "type": "string", "pattern": "^roleassignment:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Immutable UUID of this RoleAssignment", "example": "roleassignment:550e8400-e29b-41d4-a716-446655440000" }, "projectId": { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Id of the project that owns this assignment", "example": "project:abc-123" }, "principal": { "$ref": "#/components/schemas/Principal" }, "roleId": { "type": "string", "pattern": "^role:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Id of the Role assigned to the principal", "example": "role:550e8400-e29b-41d4-a716-446655440000" }, "roleName": { "type": "string", "description": "Name of the Role assigned to the principal", "example": "Network Admin" }, "assignmentScope": { "$ref": "#/components/schemas/AssignmentScope" } }, "additionalProperties": false, "type": "object", "required": [ "roleAssignmentId", "projectId", "principal", "roleId", "roleName", "assignmentScope" ], "description": "An assignment of a Role to a principal.", "x-fastmcp-top-level-schema": "RoleAssignment" }, "Access_listRolesResult": { "properties": { "list": { "$ref": "#/components/schemas/List" }, "nextPageToken": { "type": "string", "maxLength": 4096, "minLength": 1, "description": "When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous\n call.", "example": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" } }, "additionalProperties": false, "type": "object", "required": [ "list" ], "description": "A paginated list of roles.", "x-fastmcp-top-level-schema": "RoleList" }, "Accesstoken_GetOAuth2AccessTokenResult": { "required": [ "access_token", "token_timeout", "token_type", "user_name" ], "type": "object", "properties": { "access_token": { "type": "string", "description": "the OAuth2 Bearer token required to access Equinix API's" }, "token_timeout": { "type": "string", "description": "The max validity in seconds for this access_token", "default": "3599 (60 minutes)" }, "user_name": { "type": "string", "description": "The Equinix user account to which this token is associated with" }, "token_type": { "type": "string", "description": "The type of access_token returned in this response", "default": "Bearer" }, "refresh_token": { "$ref": "#/components/schemas/Refresh_token" }, "refresh_token_timeout": { "type": "string", "description": "The max validity in seconds for the refresh_token. This field is not retruned for the \"client_credentials\" grant type", "default": "5182560 (60 days)" } }, "x-fastmcp-top-level-schema": "Oauth2TokenResponse" }, "Account_0c8b1638": { "required": [ "accountName", "accountNumber", "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "Account URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/accounts/1234" }, "accountNumber": { "type": "string", "description": "Account identifier", "example": "1234533211" }, "accountName": { "type": "string", "description": "Name of account", "example": "Company account" }, "orgId": { "type": "string", "description": "Customer organization identifier", "example": "1232" }, "organizationName": { "type": "string", "description": "Customer organization name", "example": "Equinix, Inc." } } }, "Account_0dedb04b": { "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account number", "format": "int64" }, "accountName": { "type": "string", "description": "Account name" }, "orgId": { "type": "integer", "description": "Customer organization identifier", "format": "int64" }, "organizationName": { "type": "string", "description": "Customer organization name" }, "globalOrgId": { "type": "string", "description": "Global organization identifier" }, "globalOrganizationName": { "type": "string", "description": "Global organization name" }, "ucmId": { "type": "string", "description": "Account ucmId" }, "globalCustId": { "type": "string", "description": "Account name" }, "resellerAccountNumber": { "type": "integer", "description": "Reseller account number", "format": "int64" }, "resellerAccountName": { "type": "string", "description": "Reseller account name" }, "resellerUcmId": { "type": "string", "description": "Reseller account ucmId" }, "resellerOrgId": { "type": "integer", "description": "Reseller customer organization identifier", "format": "int64" } } }, "Account_2b85a339": { "required": [ "accountNumber", "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "Account URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/accounts/1234" }, "accountNumber": { "type": "string", "description": "Account identifier", "example": "1234533211" }, "accountName": { "type": "string", "description": "Name of account", "example": "Company account" }, "orgId": { "type": "string", "description": "Customer organization identifier", "example": "1232" }, "organizationName": { "type": "string", "description": "Customer organization name", "example": "Equinix, Inc." } } }, "Account_8518334f": { "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account number", "format": "int64" }, "accountName": { "type": "string", "description": "Account name" }, "orgId": { "type": "integer", "description": "Customer organization identifier", "format": "int64" }, "organizationName": { "type": "string", "description": "Customer organization name" }, "globalOrgId": { "type": "string", "description": "Global organization identifier" }, "globalOrganizationName": { "type": "string", "description": "Global organization name" }, "ucmId": { "type": "string", "description": "Account ucmId" }, "globalCustId": { "type": "string", "description": "Account name" }, "resellerAccountNumber": { "type": "integer", "description": "Reseller account number", "format": "int64" }, "resellerAccountName": { "type": "string", "description": "Reseller account name" }, "resellerUcmId": { "type": "string", "description": "Reseller account ucmId" }, "resellerOrgId": { "type": "integer", "description": "Reseller customer organization identifier", "format": "int64" } }, "description": "AM-CRH customers can provide Account number", "example": 272010 }, "Account_c1695b98": { "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account number", "format": "int64" }, "accountName": { "type": "string", "description": "Account name" }, "orgId": { "type": "integer", "description": "Customer organization identifier", "format": "int64" }, "organizationName": { "type": "string", "description": "Customer organization name" }, "globalOrgId": { "type": "string", "description": "Global organization identifier" }, "globalOrganizationName": { "type": "string", "description": "Global organization name" }, "ucmId": { "type": "string", "description": "Account ucmId" }, "globalCustId": { "type": "string", "description": "Account name" }, "resellerAccountNumber": { "type": "integer", "description": "Reseller account number", "format": "int64" }, "resellerAccountName": { "type": "string", "description": "Reseller account name" }, "resellerUcmId": { "type": "string", "description": "Reseller account ucmId" }, "resellerOrgId": { "type": "integer", "description": "Reseller customer organization identifier", "format": "int64" } }, "description": "Seller Account for Service Profile." }, "AclDetails_90ec39be": { "type": "array", "items": { "type": "object", "properties": { "interfaceType": { "enum": [ "MGMT", "WAN" ], "type": "string", "description": "Interface type, whether MGMT or WAN.", "example": "WAN" }, "uuid": { "type": "string", "description": "The unique ID of ACL.", "example": "ce7ef79e-31e7-4769-be5b-e192496f48ab" } } }, "description": "An array of ACLs" }, "AclDetails_f1a415d4": { "type": "array", "items": { "type": "object", "properties": { "interfaceType": { "enum": [ "MGMT", "WAN" ], "type": "string", "description": "Interface type, whether MGMT or WAN.", "example": "WAN" }, "uuid": { "type": "string", "description": "The unique ID of ACL.", "example": "ce7ef79e-31e7-4769-be5b-e192496f48ab" } } }, "description": "An array of ACLs." }, "Actions": { "items": { "$ref": "#/components/schemas/ActionsItem" }, "type": "array", "uniqueItems": true }, "ActionsItem": { "anyOf": [ { "type": "string", "pattern": "^action:(use|srv|ops)/([a-zA-Z][a-zA-Z0-9-]{0,100})$", "description": "Id of an action, unique across all aspects of its service", "example": "action:use/listPermissionSets" }, { "type": "string", "pattern": "^actionset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies an ActionSet within a Service.", "example": "actionset:myactions" } ] }, "ActiveProcessing": { "type": "object", "properties": { "edgeCollectedOn": { "type": "string", "description": "when tag reading was collected on source", "format": "date-time", "example": "2023-01-11T16:06:10.082000Z" }, "tagCalculationJobProcessedOn": { "type": "string", "description": "when tag reading was processed by tag-calculation rtp", "format": "date-time", "example": "2023-01-11T16:06:10.082000Z" }, "processingStartOn": { "type": "string", "description": "when tag reading was accepted by alert rtp", "format": "date-time", "example": "2023-01-11T16:06:10.082000Z" }, "processingEndOn": { "type": "string", "description": "when tag reading was processed by alert rtp", "format": "date-time", "example": "2023-01-11T16:06:10.082000Z" }, "publishedOn": { "type": "string", "description": "when tag reading was published by alert rtp", "format": "date-time", "example": "2023-01-11T16:06:10.082000Z" } } }, "AdditionalInfoItem": { "type": "object", "properties": { "reason": { "type": "string", "description": "Reason of the error\n", "example": "Unsupported request parameter value\n" }, "property": { "type": "string", "description": "Request property that caused the error\n", "example": "work.emailId" } }, "description": "Additional info for error" }, "AdditionalInfo_17816e41": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalInfoItem" }, "description": "Collection of additional information\n" }, "AdditionalInfo_35e07328": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Error code shown if an operation on the Exchange Service fails" }, "errorMessage": { "type": "string", "description": "Generic message shown if an operation on the Exchange Service fails" } }, "description": "Additional information regarding the specified Exchange Service" }, "AdditionalInfo_db75691e": { "type": "object", "properties": { "property": { "type": "string", "description": "Additional attribute for error information" }, "statusCode": { "type": "string", "description": "HTTP error status code response from sink type if error occurred" }, "reason": { "type": "string", "description": "HTTP error message response from sink type if error occurred" } }, "description": "External error information from subscription sink" }, "Additional_product_details": { "title": "Additional product details", "type": "array", "items": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "description": "This section is reserved to display product specific information", "example": [ { "key": "ASSET_ID", "value": "4-89137987923" }, { "key": "SERIAL_NUMBER", "value": "232891719" } ] }, "Address": { "type": "object", "properties": { "id": { "type": "string", "description": "Address identifier" }, "streetNr": { "type": "string", "description": "Street number of address" }, "streetName": { "type": "string", "description": "Street name of address" }, "city": { "type": "string", "description": "City of address" }, "stateOrProvince": { "type": "string", "description": "State of address" }, "postCode": { "type": "string", "description": "Postal code of address" }, "country": { "type": "string", "description": "Country of address" } }, "description": "Address." }, "Address_details": { "title": "Address details", "type": "object", "properties": { "carrierAccountNumber": { "type": "string", "description": "Shipment Carrier account number", "example": "DHL930182000" }, "shipToName": { "type": "string", "description": "Shipment receiver name", "example": "Jack Ma" }, "addressLine1": { "type": "string", "description": "Address line 1", "example": "ABC - Level 9 Communications LLC" }, "addressLine2": { "type": "string", "description": "Address line 2", "example": "CLK0l Media Processing Center" }, "city": { "type": "string", "description": "City name.", "example": "Phoenix" }, "state": { "type": "string", "description": "State of the city.", "example": "California" }, "countryCode": { "$ref": "#/components/schemas/CountryCode_46c0fb03" }, "zipCode": { "type": "string", "description": "Postal address", "example": 94086 }, "phoneNumber": { "type": "string", "description": "Ship To contact phone number", "example": "+1 6503890931" } } }, "AddressingPlans": { "type": "array", "items": { "required": [ "size" ], "type": "object", "properties": { "size": { "minimum": 1.0, "type": "integer" }, "purpose": { "enum": [ "ROUTERS", "SWITCHES", "FIREWALLS", "SERVERS", "LOAD_BALANCERS", "VPN_ENDPOINTS", "END_USERS" ], "type": "string", "description": "Purpose of PA Ip block for regulatory reasons", "example": "ROUTERS" } } }, "description": "Collection of addressing plans" }, "AdminPassword": { "type": "string", "description": "The administrative password of the device. You can use it to log in to the console. This field is not available for all device types. Should be at least 6 characters long and must include an uppercase letter and a number. This field may be required for some vendors.", "example": "ZQeIDI7sUd" }, "AllowOverSubscription": { "type": "boolean", "description": "Setting showing that oversubscription support is available (true) or not (false). The default is false.\nOversubscription is the sale of more than the available network bandwidth. This practice is common\nand legitimate. After all, many customers use less bandwidth than they've purchased.\nAnd network users don't consume bandwidth all at the same time. The leftover bandwidth can be sold to\nother customers. When demand surges, operational and engineering resources can be shifted to\naccommodate the load.\n", "default": false, "example": false }, "AllowedActions": { "type": "array", "items": { "$ref": "#/components/schemas/AllowedActionsItem" }, "description": "List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint.\n" }, "AllowedActionsItem": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Type_2066d11d" } } }, "AndItem_14a4cfa9": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_5dff40c1" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `[NOT] BETWEEN` - (not) between\n * `[NOT] LIKE` - (not) like\n * `[NOT] IN` - (not) in\n * `ILIKE` - case-insensitive like\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "FabricPrecisionTimeService-1" } } } }, "AndItem_29e7c5f3": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_b758e131" }, "operator": { "$ref": "#/components/schemas/Operator_64b8e854" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string", "example": "12f4d4a1-c7cb-4def-9f77-5ce93c19d999" } } } }, "AndItem_2aa4a34a": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/type` - Route table entry type\n * `/state` - Route table entry state\n * `/prefix` - Route table entry prefix\n * `/nextHop` - Route table entry nextHop\n * `/*` - all-category search\n", "example": "/type" }, "operator": { "$ref": "#/components/schemas/Operator_a87d6981" }, "values": { "type": "array", "items": { "type": "string", "example": "IPv4_BGP_ROUTE" } } } }, "AndItem_2c83a590": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_10db7990" }, "operator": { "$ref": "#/components/schemas/Operator_e348ff21" }, "values": { "type": "array", "items": { "type": "string", "example": "Gateway" } } } }, "AndItem_384c5f84": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/uuid` - App Processor attach to App Link uuid\n * `/attachmentStatus` - App Processor attach to App Link status\n", "example": "/attachmentStatus" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `IN` - in\n * `NOT IN` - not in\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "ATTACHED" } } } }, "AndItem_394410d0": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_c8297d68" }, "operator": { "$ref": "#/components/schemas/Operator_64b8e854" }, "values": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string", "example": "stream-dev-01" } } } }, "AndItem_457cf0a7": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/uuid` - App Subscription UUID\n * `/state` - App Subscription lifecycle state\n", "example": "/state" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `IN` - in\n * `NOT IN` - not in\n", "example": "IN" }, "values": { "type": "array", "items": { "type": "string", "example": "PROVISIONED" } } } }, "AndItem_49ae97d4": { "required": [ "operator", "property", "values" ], "type": "object", "properties": { "property": { "type": "string", "description": "Field name", "example": "status" }, "operator": { "enum": [ "<=", ">=", "LIKE", "IN", "=", "!=" ], "type": "string", "description": "Condition used to compare the property and the value(s).", "example": "=" }, "values": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Array of values to be compared with the field." } } }, "AndItem_502845be": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/uuid` - App Service attach to App Link uuid\n * `/attachmentStatus` - App Service attach to App Link status\n", "example": "/attachmentStatus" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `IN` - in\n * `NOT IN` - not in\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "Gateway" } } } }, "AndItem_58ed4f6e": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/uuid` - App Domain attach to App Link uuid\n * `/attachmentStatus` - App Domain attach to App Link status\n", "example": "/attachmentStatus" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `IN` - in\n * `NOT IN` - not in\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "Gateway" } } } }, "AndItem_6ecd3b31": { "type": "object", "properties": { "property": { "enum": [ "/type", "/state", "/uuid" ], "type": "string", "description": "Possible field names to use on filters." }, "operator": { "enum": [ "=", "!=", "LIKE", "ILIKE", "BETWEEN", "NOT BETWEEN", "IN", "NOT IN", ">", "<", ">=", "<=" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string", "example": "XC_SIGNATURE_SUBMISSION" } } } }, "AndItem_7dd22fb7": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/AndItem_2aa4a34a" }, { "$ref": "#/components/schemas/AndItem_89204c30" } ] }, "AndItem_89204c30": { "type": "object", "properties": { "or": { "$ref": "#/components/schemas/Or" } } }, "AndItem_8c14da5c": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_1e8cf171" }, "operator": { "$ref": "#/components/schemas/Operator_e348ff21" }, "values": { "type": "array", "items": { "type": "string", "example": "Gateway" } } } }, "AndItem_8d567a14": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/uuid` - Asset uuid (`=` and `IN` only)\n * `/streamUuid` - Stream uuid (`=` and `IN` only)\n * `/attachmentStatus` - Asset attachment status (`=`, `IN`, and `NOT IN`)\n", "example": "/streamUuid" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `IN` - in\n * `NOT IN` - not in\n", "example": "=" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string", "example": "4719e319-65ae-4001-aabf-ca5f107b9b29" } } } }, "AndItem_91361e81": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/type` - type of update\n * `/state` - action state\n * `/connection/uuid` - connection uuid associated\n * `/*` - all-category search\n", "example": "/type" }, "operator": { "$ref": "#/components/schemas/Operator_a87d6981" }, "values": { "type": "array", "items": { "type": "string", "example": "ROUTE_TABLE_ENTRY_UPDATE" } } } }, "AndItem_9a109001": { "type": "object", "properties": { "property": { "enum": [ "/type", "/state", "/uuid" ], "type": "string", "description": "Possible field names to use on filters" }, "operator": { "enum": [ "=", "!=", "LIKE", "ILIKE", "BETWEEN", "NOT BETWEEN", "IN", "NOT IN", ">", "<", ">=", "<=" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string", "example": "LOA_ACCEPTANCE" } } } }, "AndItem_a41728ec": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_bf00e210" }, "operator": { "$ref": "#/components/schemas/Operator_a87d6981" }, "values": { "type": "array", "items": { "type": "string", "example": "PING_COMMAND" } } } }, "AndItem_a6113db6": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_13a1d620" }, "operator": { "enum": [ "=", "!=", "LIKE", "ILIKE", "BETWEEN", "NOT BETWEEN", "IN", "NOT IN", ">", "<", ">=", "<=" ], "type": "string", "example": "=" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "Loa-2026" ] } } }, "AndItem_b1b502bb": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_e48e02b3" }, "operator": { "$ref": "#/components/schemas/Operator_e348ff21" }, "values": { "type": "array", "items": { "type": "string", "example": "Gateway" } } } }, "AndItem_c7b7b656": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_776737e2" }, "operator": { "$ref": "#/components/schemas/Operator_e348ff21" }, "values": { "type": "array", "items": { "type": "string", "example": "Gateway" } } } }, "AndItem_cbfced43": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_6d8beca1" }, "operator": { "$ref": "#/components/schemas/Operator_e348ff21" }, "values": { "type": "array", "items": { "type": "string", "example": "Gateway" } } } }, "AndItem_d06bfc44": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/subject` - subject\n * `/type` - type\n", "example": "/type" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `in` - in\n * `LIKE` - case-sensitive like\n * `ILIKE` - case-insensitive like\n", "example": "=" }, "values": { "$ref": "#/components/schemas/Values" } } }, "AndItem_d21b92ee": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_c6fb7fed" }, "operator": { "$ref": "#/components/schemas/Operator_a87d6981" }, "values": { "type": "array", "items": { "type": "string", "example": "IPv4_BGP_ROUTE" } } } }, "AndItem_d83e72f9": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/name` - Connection name\n * `/uuid` - Connection uuid\n * `/type` - type\n * `/state` - state\n * `/bandwidth` - Bandwidth\n", "example": "/name" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `[NOT] BETWEEN` - (not) between\n * `[NOT] LIKE` - (not) like\n * `[NOT] IN` - (not) in\n * `ILIKE` - case-insensitive like\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "123456-SV1-SV2-01" } } } }, "AndItem_e20022a7": { "required": [ "property", "operator", "values" ], "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_c9ecba32" }, "operator": { "$ref": "#/components/schemas/Operator_81d6289e" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "PROVISIONED", "PENDING" ] } } }, "AndItem_fa49c441": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_bbafc745" }, "operator": { "enum": [ "=", "!=", "LIKE", "ILIKE", "BETWEEN", "NOT BETWEEN", "IN", "NOT IN", ">", "<", ">=", "<=" ], "type": "string", "example": "=" }, "values": { "type": "array", "items": { "type": "string" }, "example": [ "My-CC-service" ] } } }, "And_32083f06": { "maxItems": 8, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_7dd22fb7" } }, "And_f944b113": { "type": "array", "items": { "$ref": "#/components/schemas/AndItem_49ae97d4" }, "description": "Array of search conditions." }, "ApiConfig": { "type": "object", "properties": { "apiAvailable": { "type": "boolean", "description": "Setting indicating whether the API is available (true) or not (false).", "default": false, "example": true }, "integrationId": { "type": "string" }, "equinixManagedPort": { "type": "boolean", "description": "Setting indicating that the port is managed by Equinix (true) or not (false).", "default": false, "example": true }, "equinixManagedVlan": { "type": "boolean", "description": "Setting indicating that the VLAN is managed by Equinix (true) or not (false).", "default": false, "example": true }, "allowOverSubscription": { "$ref": "#/components/schemas/AllowOverSubscription" }, "overSubscriptionLimit": { "maximum": 20.0, "minimum": 1.0, "type": "integer", "description": "A cap on oversubscription.", "default": 1, "example": 1 }, "bandwidthFromApi": { "type": "boolean", "default": false } }, "description": "Configuration for API based Integration for Service Profile" }, "ApiIntegration": { "type": "object", "properties": { "siteValidationEnabled": { "type": "boolean", "description": "Whether site validation is enabled for the last-mile provider." }, "dataCenterLocationEnabled": { "type": "boolean", "description": "Whether data center location is enabled for the last-mile provider." }, "productOfferingEnabled": { "type": "boolean", "description": "Whether product offering is enabled for the last-mile provider." }, "poqEnabled": { "type": "boolean", "description": "Whether product qualification is enabled for the last-mile provider." }, "quoteEnabled": { "type": "boolean", "description": "Whether quote generation is enabled for the last-mile provider." }, "placeOrderEnabled": { "type": "boolean", "description": "Whether place order is enabled for the last-mile provider." }, "quoteViaAggregatorEnabled": { "type": "boolean", "description": "Whether quote via aggregator is enabled for the last-mile provider." } }, "description": "Last-mile API integration details." }, "AppLink": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 1 }, "type": { "type": "string", "description": "App Link Type", "example": "APP_LINK", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 3 } }, "description": "App Link reference for App Subscription" }, "AppService": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 1 }, "type": { "type": "string", "description": "App Service Type", "example": "APP_SERVICE", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 3 } }, "description": "App Service reference for App Subscription" }, "AsnSearchSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } }, "AssetItem": { "required": [ "accountNumber", "ibx" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "135888" }, "ibx": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "assetClassification": { "maxItems": 2147483647, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "enum": [ "MECHANICAL", "ENVIRONMENTAL", "ELECTRICAL" ], "type": "string" }, "description": "Asset Classification value if specified, otherwise all allowable classifications" }, "assetId": { "maxItems": 2147483647, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "description": "Asset messages provide the latest readings for environmental, electrical, and mechanical assets within an IBX" }, "Asset_be358951": { "type": "array", "items": { "$ref": "#/components/schemas/AssetItem" }, "description": "List of asset message type to subscribe" }, "Asset_f8c64911": { "type": "object", "properties": { "ibx": { "type": "string", "description": "ibx", "example": "PA8A" }, "assetUid": { "type": "string", "description": "asset unique id", "example": "PA8A.CB-CRITICAL-DB2" }, "assetType": { "type": "string", "description": "asset type", "example": "Circuit Breaker with Metering" }, "assetClassification": { "type": "string", "description": "asset classification", "example": "Electrical" }, "assetRegion": { "type": "string", "description": "asset region", "example": "EMEA" }, "assetUnderMaintenance": { "type": "boolean", "description": "asset was under maintenance during alert processing", "example": false } } }, "AssetsItem_60fc15f5": { "type": "object", "properties": { "uuid": { "type": "string", "example": "52fbdb3f-8def-410d-868b-ef920878bff8" }, "service": { "type": "object", "properties": { "href": { "type": "string" }, "type": { "enum": [ "IA" ], "type": "string" }, "uuid": { "type": "string", "example": "52fbdb3f-8def-410d-868b-ef920878bff8" } }, "description": "Associated Internet Access Service reference" }, "announcingMetro": { "type": "string", "example": "LD" }, "ipBlocks": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "type": { "enum": [ "IPV4_IP_BLOCK", "IPV6_IP_BLOCK" ], "type": "string" }, "uuid": { "type": "string", "example": "129afa61-f706-41cb-a03a-69a276bdb0b4" } } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Asset associated with ASN" }, "AssetsItem_bd978255": { "required": [ "type", "uuid", "href" ], "type": "object", "properties": { "type": { "enum": [ "EIA", "FABRIC", "NE" ], "type": "string" }, "uuid": { "type": "string", "description": "Unique identifier for the asset", "format": "uuid" }, "href": { "type": "string", "description": "Resource URL path for the linked resource", "example": "https://api.equinix.com/fabric/v4/internetAccesses/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92" } } }, "Assets_74bfea69": { "type": "array", "items": { "$ref": "#/components/schemas/CAGEItem" } }, "Assets_7c79a22a": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsItem_60fc15f5" } }, "Assets_a652916b": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsItem_bd978255" }, "description": "Products using this IP Block" }, "AssignmentScope": { "properties": { "id": { "type": "string", "example": "07218c48-343d-43e2-9831-a2080445cd22" }, "type": { "type": "string", "description": "Type of object refered to by assignmentScope id", "examples": [ "PDS_ORG", "ORGANIZATION", "PROJECT", "BILLING_ACCOUNT", "SUBSCRIPTION_KEY", "PORT" ], "example": "PROJECT" }, "name": { "type": "string", "description": "Name of object refered to by assignmentScope id", "example": "My Project" }, "parent": { "$ref": "#/components/schemas/Parent" } }, "additionalProperties": false, "type": "object", "required": [ "id", "type" ], "description": "The scope this assignment applies to, usually a specific Project or Organization." }, "AssignmentScopeTypes": { "items": { "type": "string", "description": "Type of object that defines the scope of a role assignment (e.g. PROJECT, ORGANIZATION).", "examples": [ "PDS_ORG", "ORGANIZATION", "PROJECT", "BILLING_ACCOUNT", "SUBSCRIPTION_KEY", "PORT" ], "example": "PROJECT" }, "type": "array", "uniqueItems": true, "description": "This Role may be assigned to a scope of any of these types." }, "Attachment_0aac561a": { "title": "Attachment", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Attachment ID", "example": "eb9ab7e9-3785-41e4-af24-74b8dc37b254" }, "name": { "minLength": 1, "type": "string", "description": "Attachment filename", "example": "uecp-finance-service-api-swagger.yml" } } }, "Attachment_4e90c1b5": { "title": "Attachment", "required": [ "attachmentId", "attachmentName", "attachmentType", "attachmentSize", "createdDate", "createdBy", "lastUpdatedDate" ], "type": "object", "properties": { "attachmentId": { "type": "string", "description": "Unique Identifier for the attachment", "format": "uuid" }, "attachmentName": { "type": "string", "description": "File name of the attachment" }, "attachmentType": { "type": "string", "description": "Extension of the document" }, "attachmentSize": { "maximum": 1000000000.0, "minimum": 0.0, "type": "number", "description": "size of the attachment in bytes", "default": 0 }, "createdDate": { "type": "string", "description": "Created date", "format": "date-time" }, "createdBy": { "type": "string", "description": "User key of the author of the attachment" }, "lastUpdatedDate": { "type": "string", "description": "Last accessed date for the record", "format": "date-time" } }, "description": "Attachment meta data", "example": { "attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093", "attachmentName": "Example_Invoice.pdf", "attachmentType": "application/pdf", "attachmentSize": 259387, "createdDate": "2017-01-31T09:03:08.340Z", "createdBy": "john.doe@example.com", "lastUpdatedDate": "2017-04-06T17:10:44.807Z" }, "x-fastmcp-top-level-schema": "attachment" }, "Attachment_f2f3b5df": { "title": "Attachment", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Attachement Id generated from Attachment Api", "example": "eb9ab7e9-3785-41e4-af24-112dff" }, "name": { "minLength": 1, "type": "string", "description": "Attachment file name, Please make sure attachment name which is used while uploading via Attachment Api", "example": "eb9ab7e9-3785-41e4-af24-asfsa5424" } } }, "AttachmentsItem_3a0c3cd7": { "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Identifier of the binary attachment UUID.", "example": "c77c5f58-a7ea-4e88-9fc4-1a2900027425" }, "name": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Name of the binary attachment.", "example": "error-log" } }, "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other." }, "AttachmentsItem_545728ea": { "type": "object", "properties": { "href": { "type": "string", "description": "URI to the attachment resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Attachment resource Identifier.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "attachmentId": { "type": "string", "description": "Attachment Identifier.", "format": "uuid", "example": "a11f485e-3094-42de-8797-0ef19a51df79" } }, "description": "Document the action applies to." }, "AttachmentsItem_732c8a2f": { "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Identifier of the binary attachment UUID.", "example": "c77c5f58-a7ea-4e88-9fc4-1a2900027425" }, "name": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Name of the binary attachment.", "example": "error-log" }, "source": { "enum": [ "CUSTOMER", "EQUINIX" ], "type": "string", "description": "Source of the binary attachment.", "example": "CUSTOMER" } }, "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other." }, "AttachmentsItem_73586a8c": { "maxItems": 5, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_732c8a2f" }, "description": "File(s) attached to the trouble ticket. e.g. picture of broken device, scanning of a bill or charge, etc..." }, "AttachmentsItem_7dcbc88d": { "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Identifier of the binary attachment UUID.", "example": "c77c5f58-a7ea-4e88-9fc4-1a2900027425" }, "name": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Name of the binary attachment." } }, "description": "Attachment request" }, "AttachmentsItem_9611d752": { "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Identifier of the attachment.", "example": "c77c5f58-a7ea-4e88-9fc4-1a2900027425" }, "name": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Name of the attachment.", "example": "error-log" } }, "description": "Attachment refers to extensions or additional parts that is or may be attached to something (agreements, contracts, appointments) to perform a particular function. They can be communication attachments, documents and other." }, "AttachmentsItem_f75b83cc": { "type": "object", "properties": { "id": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Identifier of the binary attachment UUID.", "example": "c77c5f58-a7ea-4e88-9fc4-1a2900027425" }, "name": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Name of the binary attachment.", "example": "error-log" } }, "description": "Attachments" }, "Attachments_18af2a37": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_545728ea" }, "description": "Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL." }, "Attachments_32698a8e": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_f75b83cc" }, "description": "File(s) attached to the Orders. To learn about including attachments in your request, see POST Attachments API." }, "Attachments_34059b89": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/Attachment_0aac561a" }, "description": "Attachments" }, "Attachments_520ac97b": { "maxItems": 5, "type": "array", "items": { "required": [ "attachmentId" ], "type": "object", "properties": { "attachmentId": { "type": "string", "description": "Attachment Identifier.", "format": "uuid", "example": "a11f485e-3094-42de-8797-0ef19a51df79" } }, "description": "Cross Connect Attachment." }, "description": "Additional Attachments." }, "Attachments_861931ea": { "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/AttachmentsItem_9611d752" }, "description": "File(s) attached to the ticket. e.g. picture of broken device, scanned copy of bill or charge. To learn about including attachments in your request, see POST Attachments API." }, "Attachments_Array": { "title": "Attachments Array", "maxItems": 5, "type": "array", "items": { "$ref": "#/components/schemas/Attachment_f2f3b5df" }, "description": "Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following formats - bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd." }, "Attributes": { "items": { "$ref": "#/components/schemas/AttributesItem" }, "type": "array", "uniqueItems": true }, "AttributesItem": { "properties": { "attributeId": { "type": "string", "pattern": "^attribute:[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Identifies an existing attribute for this service.", "example": "attribute:myAttr" }, "attributeOptional": { "type": "boolean", "description": "If `true`, then this attribute is always present, otherwise the attribute may or may not be\n present.", "example": true } }, "additionalProperties": false, "type": "object", "required": [ "attributeId" ] }, "Auth": { "type": "object", "properties": { "authtype": { "enum": [ "system", "user" ], "type": "string", "description": "Cloud Event auth type" }, "authid": { "enum": [ "equinix", "userId" ], "type": "string", "description": "Cloud Event auth identifier" }, "name": { "type": "string", "description": "Cloud Event username" }, "email": { "type": "string", "description": "Cloud Event email" } } }, "AzureChannelConfiguration": { "type": "object", "properties": { "numberOfRetries": { "maximum": 5.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "numberOfConcurrentCalls": { "maximum": 50.0, "minimum": 20.0, "type": "integer", "format": "int32" }, "batchSize": { "maximum": 20.0, "minimum": 5.0, "type": "integer", "format": "int32" } }, "description": "The configuration for an 'AZURE' channel" }, "BandwidthUtilization": { "type": "object", "properties": { "unit": { "enum": [ "Mbps" ], "type": "string", "description": "Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second." }, "metricInterval": { "type": "string", "description": "An interval formatted value, indicating the time-interval the metric objects within the response represent" }, "inbound": { "$ref": "#/components/schemas/Inbound_13f2d2f3" }, "outbound": { "$ref": "#/components/schemas/Inbound_13f2d2f3" } }, "description": "Bandwidth utilization statistics (octet counters-based)" }, "Bas_getBillingAccountByAccountIdResult": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Result_0b57c25e" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true }, "BgpIpv4_282c75d4": { "type": "object", "properties": { "customerPeerIp": { "type": "string", "description": "Customer peer IP address", "example": "12.1.1.1" }, "domainName": { "type": "string", "description": "Domain name for BGP", "example": "ix-v4.gw01.sin.example.net" }, "primaryRouteServerIp": { "type": "string", "description": "Primary route server IP address with prefix length", "example": "206.126.239.251/22" }, "secondaryRouteServerIp": { "type": "string", "description": "Secondary route server IP address with prefix length", "example": "206.126.239.252/22" }, "asSet": { "type": "string", "description": "AS-SET used to filter the prefixes announced by the customer", "example": "AS-EC-SV" }, "mlpeEnabled": { "type": "boolean", "description": "Whether Multi-Lateral Peering Exchange (MLPE) is enabled", "example": true }, "md5AuthKey": { "type": "string", "description": "MD5 key for BGP", "example": "TestAuthKey12345" }, "rcMd5AuthKey": { "type": "string", "description": "RC MD5 key for BGP", "example": "TestAuthKey123456" }, "prefixes": { "type": "array", "items": { "type": "string", "description": "IP prefix" }, "description": "List of IP prefix" }, "maxPrefixLimit": { "type": "integer", "description": "Max Prefix Limit number", "format": "int64", "example": 300 }, "prependSelfEnabled": { "type": "boolean", "description": "Prepend Self Enabled", "example": true } } }, "BgpIpv4_c81b618c": { "type": "object", "properties": { "domainName": { "maxLength": 253, "minLength": 1, "type": "string", "description": "Domain name for BGP", "example": "gw01.sin.example.net" }, "asSet": { "maxLength": 48, "minLength": 2, "type": "string", "description": "AS-SET used to filter the prefixes announced by the customer", "example": "AS-EC-SV" }, "mlpeEnabled": { "type": "boolean", "description": "Whether Multi-Lateral Peering Exchange (MLPE) is enabled", "default": false, "example": true }, "md5AuthKey": { "maxLength": 255, "minLength": 1, "type": "string", "description": "MD5 key for BGP", "example": "TestAuthKey12345" }, "rcMd5AuthKey": { "maxLength": 255, "minLength": 1, "type": "string", "description": "RC MD5 key for BGP", "example": "TestAuthKey123456" }, "prefixes": { "type": "array", "items": { "type": "string", "description": "IP prefix" }, "description": "List of IP prefix" }, "maxPrefixLimit": { "type": "integer", "description": "Max Prefix Limit number", "format": "int64", "example": 300 }, "prependSelfEnabled": { "type": "boolean", "description": "Prepend Self Enabled", "default": true, "example": true } } }, "BgpIpv4_c8b763be": { "required": [ "customerPeerIp", "enabled" ], "type": "object", "properties": { "customerPeerIp": { "type": "string", "description": "Customer side peering ip", "example": "10.1.1.2" }, "equinixPeerIp": { "type": "string", "description": "Equinix side peering ip", "example": "10.1.1.3" }, "enabled": { "type": "boolean", "description": "Admin status for the BGP session" }, "outboundASPrependCount": { "type": "integer", "description": "AS path prepend count", "format": "int64", "example": 3 }, "inboundMED": { "type": "integer", "description": "Inbound Multi Exit Discriminator attribute", "format": "int64", "example": 1000 }, "outboundMED": { "type": "integer", "description": "Outbound Multi Exit Discriminator attribute", "format": "int64", "example": 2000 }, "routesMax": { "type": "integer", "description": "Maximum learnt prefixes limit", "format": "int64", "example": 1000 }, "operation": { "$ref": "#/components/schemas/Operation_efa7ab78" } } }, "BgpIpv6": { "required": [ "customerPeerIp", "enabled" ], "type": "object", "properties": { "customerPeerIp": { "type": "string", "description": "Customer side peering ip", "example": "2001:db8:c59b::1" }, "equinixPeerIp": { "type": "string", "description": "Equinix side peering ip", "example": "2001:db8:c59b::1" }, "enabled": { "type": "boolean", "description": "Admin status for the BGP session" }, "outboundASPrependCount": { "type": "integer", "description": "AS path prepend count", "format": "int64", "example": 3 }, "inboundMED": { "type": "integer", "description": "Inbound Multi Exit Discriminator attribute", "format": "int64", "example": 1000 }, "outboundMED": { "type": "integer", "description": "Outbound Multi Exit Discriminator attribute", "format": "int64", "example": 2000 }, "routesMax": { "type": "integer", "description": "Maximum learnt prefixes limit", "format": "int64", "example": 1000 }, "operation": { "$ref": "#/components/schemas/Operation_efa7ab78" } } }, "BillingContact": { "title": "BillingContact", "required": [ "firstName", "lastName", "email" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name" }, "lastName": { "type": "string", "description": "Last name" }, "email": { "type": "string", "description": "Email address", "format": "email" } }, "example": { "firstName": "John", "lastName": "Doe", "email": "john.doe@example.lk" }, "description": "Details of billing contact" }, "Billing_5af391da": { "required": [ "currency", "poBearing", "poExempted", "signatureRequired" ], "type": "object", "properties": { "signatureRequired": { "type": "boolean", "description": "Whether the signature is required", "example": false }, "poExempted": { "type": "boolean", "description": "Whether the purchase order has been exempted", "example": true }, "poBearing": { "type": "boolean", "description": "Whether the purchase order is required", "example": true }, "currency": { "$ref": "#/components/schemas/Currency" } } }, "Billing_e95cc35e": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "x-enum-varnames": [ "FIXED", "USAGE_BASED", "BURST_BASED" ] }, "enabled": { "type": "boolean", "description": "Indicates whether the billing is enabled" }, "startDate": { "type": "string", "description": "The start date for the billing period", "format": "date-time" } } }, "Body_034a87c0": { "required": [ "type", "name", "authorizedProductType" ], "type": "object", "properties": { "type": { "enum": [ "CAGE_LOA", "PATCH_PANEL_LOA", "PATCH_PANEL_PORT_LOA" ], "type": "string", "description": "Type of Letter of Authorization\n", "example": "PATCH_PANEL_PORT_LOA" }, "name": { "maxLength": 50, "minLength": 3, "type": "string", "description": "A short, descriptive name for this LOA.", "example": "LOA-Equinix-SV1-2026" }, "description": { "maxLength": 450, "minLength": 0, "type": "string", "description": "Additional context about this LOA.", "example": "Authorization for patch panel port access to Equinix at SV1" }, "authorizedProductType": { "enum": [ "XC", "XF_PORT", "VD" ], "type": "string", "description": "Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge\n", "example": "XC" } }, "description": "Create Loa" }, "Body_f11126d9": { "type": "string", "description": "IBX Notification event Email body content.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum" }, "CAGEItem": { "type": "object", "properties": { "assetId": { "type": "string", "description": "Unique identifier of the asset (e.g., cage, cabinet, or circuit ID)", "example": "SV5:01:A1234" }, "assetName": { "type": "string", "description": "Display name of the asset", "example": "Customer Cage 1" } }, "description": "An asset included in a power alert configuration" }, "CabinetDimensions": { "required": [ "width", "depth", "height" ], "type": "object", "properties": { "width": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "integer", "description": "Dimension Value", "example": 482 }, "unit": { "enum": [ "MILLIMETER", "CENTIMETER", "METER" ], "type": "string", "description": "Unit of measure of the product", "example": "MILLIMETER" } } }, "depth": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "integer", "description": "Dimension Value", "example": 482 }, "unit": { "enum": [ "MILLIMETER", "CENTIMETER", "METER" ], "type": "string", "description": "Unit of measure of the product", "example": "MILLIMETER" } } }, "height": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "integer", "description": "Dimension Value", "example": 482 }, "unit": { "enum": [ "MILLIMETER", "CENTIMETER", "METER" ], "type": "string", "description": "Unit of measure of the product", "example": "MILLIMETER" } } } } }, "Cages": { "minItems": 1, "type": "array", "items": { "required": [ "cage", "accountNumber" ], "type": "object", "properties": { "cage": { "minLength": 1, "type": "string", "example": "AM1:01:001MC3" }, "accountNumber": { "minLength": 1, "type": "string", "example": "12345" }, "cabinets": { "type": "array", "items": { "type": "string", "example": "AM1:01:001MC3:0102" } } } } }, "ChangeLog_4755022f": { "required": [ "createdBy", "createdByEmail", "createdByFullName", "createdDateTime", "updatedBy", "updatedByEmail", "updatedByFullName", "updatedDateTime" ], "type": "object", "properties": { "createdBy": { "type": "string" }, "createdByFullName": { "type": "string" }, "createdByEmail": { "type": "string", "format": "email" }, "createdDateTime": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "updatedByFullName": { "type": "string" }, "updatedByEmail": { "type": "string", "format": "email" }, "updatedDateTime": { "type": "string", "format": "date-time" }, "deletedBy": { "type": "string" }, "deletedByFullName": { "type": "string" }, "deletedByEmail": { "type": "string", "format": "email" }, "deletedDateTime": { "type": "string", "format": "date-time" } } }, "ChangeLog_4b21b6d2": { "type": "object", "properties": { "createdBy": { "type": "string", "description": "Created by User Key", "example": "johnsmith" }, "createdByFullName": { "type": "string", "description": "Created by User Full Name", "example": "John Smith" }, "createdByEmail": { "type": "string", "description": "Created by User Email Address", "example": "john.smith@example.com" }, "createdDateTime": { "type": "string", "description": "Created by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedBy": { "type": "string", "description": "Updated by User Key", "example": "johnsmith" }, "updatedByFullName": { "type": "string", "description": "Updated by User Full Name", "example": "John Smith" }, "updatedByEmail": { "type": "string", "description": "Updated by User Email Address", "example": "john.smith@example.com" }, "updatedDateTime": { "type": "string", "description": "Updated by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "deletedBy": { "type": "string", "description": "Deleted by User Key", "example": "johnsmith" }, "deletedByFullName": { "type": "string", "description": "Deleted by User Full Name", "example": "John Smith" }, "deletedByEmail": { "type": "string", "description": "Deleted by User Email Address", "example": "john.smith@example.com" }, "deletedDateTime": { "type": "string", "description": "Deleted by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, "description": "Change log" }, "ChangeLog_94e8bdf1": { "type": "object", "properties": { "createdBy": { "type": "string", "description": "Created by User Key", "example": "johnsmith" }, "createdByFullName": { "type": "string", "description": "Created by User Full Name", "example": "John Smith" }, "createdByEmail": { "type": "string", "description": "Created by User Email Address", "example": "john.smith@example.com" }, "createdDateTime": { "type": "string", "description": "Created by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedBy": { "type": "string", "description": "Updated by User Key", "example": "johnsmith" }, "updatedByFullName": { "type": "string", "description": "Updated by User Full Name", "example": "John Smith" }, "updatedByEmail": { "type": "string", "description": "Updated by User Email Address", "example": "john.smith@example.com" }, "updatedDateTime": { "type": "string", "description": "Updated by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "deletedBy": { "type": "string", "description": "Deleted by User Key", "example": "johnsmith" }, "deletedByFullName": { "type": "string", "description": "Deleted by User Full Name", "example": "John Smith" }, "deletedByEmail": { "type": "string", "description": "Deleted by User Email Address", "example": "john.smith@example.com" }, "deletedDateTime": { "type": "string", "description": "Deleted by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, "description": "Seller Account for Service Profile." }, "ChangeLog_998bd88d": { "allOf": [ { "$ref": "#/components/schemas/ChangeLog_a9aa0994" } ] }, "ChangeLog_a9aa0994": { "type": "object", "properties": { "createdDateTime": { "type": "string", "description": "Created Date and Time.", "format": "date-time", "example": "2026-02-28T07:21:39Z" }, "createdBy": { "type": "string", "description": "User key of the user who created the resource.", "example": "1234" }, "updatedDateTime": { "type": "string", "description": "Updated Date and Time.", "format": "date-time", "example": "2026-02-28T07:21:39Z" }, "updatedBy": { "type": "string", "description": "User key of the user who last updated the resource.", "example": "1234" } }, "description": "Cross Connect Change Log." }, "ChangeLog_c32c50f9": { "type": "object", "properties": { "createdBy": { "type": "string", "description": "Created by User Key", "example": "johnsmith" }, "createdByFullName": { "type": "string", "description": "Created by User Full Name", "example": "John Smith" }, "createdByEmail": { "type": "string", "description": "Created by User Email Address", "example": "john.smith@example.com" }, "createdDateTime": { "type": "string", "description": "Created by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedBy": { "type": "string", "description": "Updated by User Key", "example": "johnsmith" }, "updatedByFullName": { "type": "string", "description": "Updated by User Full Name", "example": "John Smith" }, "updatedByEmail": { "type": "string", "description": "Updated by User Email Address", "example": "john.smith@example.com" }, "updatedDateTime": { "type": "string", "description": "Updated by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, "description": "Change log" }, "ChangeLog_ea2ded3e": { "required": [ "createdBy", "createdByEmail", "createdByFullName", "createdDateTime", "updatedBy", "updatedByEmail", "updatedByFullName", "updatedDateTime" ], "type": "object", "properties": { "createdBy": { "type": "string", "description": "Account number of the account used for object creation", "example": "1232" }, "createdByFullName": { "type": "string", "description": "Full name of the account used for object creation", "example": "John Doe" }, "createdByEmail": { "type": "string", "description": "E-mail of the account used for object creation", "format": "email", "example": "john.doe@company.com" }, "createdDateTime": { "type": "string", "description": "Date and time of object creation", "format": "date-time" }, "updatedBy": { "type": "string", "description": "Account number of the account that updated the object last time", "example": "1234" }, "updatedByFullName": { "type": "string", "description": "Full name of the account that updated the object last time", "example": "Ryan Einstein" }, "updatedByEmail": { "type": "string", "description": "E-mail of the account that updated the object last time", "format": "email", "example": "ryan.einstein@company.com" }, "updatedDateTime": { "type": "string", "description": "Date and time of the account that updated the object last time", "format": "date-time" }, "deletedBy": { "type": "string", "description": "Account number of the account that updated the object last time", "example": "1234" }, "deletedByFullName": { "type": "string", "description": "Full name of the account that updated the object last time", "example": "Ryan Einstein" }, "deletedByEmail": { "type": "string", "description": "E-mail of the account that updated the object last time", "format": "email", "example": "ryan.einstein@company.com" }, "deletedDateTime": { "type": "string", "description": "Date and time of the account that updated the object last time", "format": "date-time" } } }, "Change_00fe696a": { "allOf": [ { "$ref": "#/components/schemas/Change_25b14a96" }, { "$ref": "#/components/schemas/Change_b615ff08" } ], "required": [ "status" ] }, "Change_042d43c7": { "allOf": [ { "$ref": "#/components/schemas/Change_25b14a96" }, { "$ref": "#/components/schemas/Change_c53402e9" } ], "required": [ "status" ] }, "Change_0b77c634": { "required": [ "type", "updatedDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "APP_SERVICE_UPDATE" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2026-06-29T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2026-06-29T07:15:00Z" }, "data": { "$ref": "#/components/schemas/Data_4dca6a2b" } }, "description": "Current state of latest AppService change" }, "Change_18dae99f": { "type": "object", "properties": { "href": { "type": "string", "description": "Network URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9" }, "uuid": { "type": "string", "description": "Uniquely identifies a change", "format": "uuid", "example": "4b17da68-3d6b-436d-9c8f-2105f3b950d9" }, "type": { "enum": [ "NETWORK_CREATION", "NETWORK_UPDATE", "NETWORK_DELETION" ], "type": "string", "description": "Type of change", "example": "NETWORK_CREATION" } }, "description": "Current state of latest network change" }, "Change_234a348c": { "allOf": [ { "$ref": "#/components/schemas/Change_25b14a96" }, { "$ref": "#/components/schemas/Change_63708aef" } ], "required": [ "status" ] }, "Change_252edc53": { "required": [ "type", "createdDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "type": "string", "description": "Type of change", "example": "SERVICE_PROFILE_VISIBILITY_UPDATE" }, "status": { "enum": [ "APPROVED", "COMPLETED", "FAILED", "REJECTED", "REQUESTED", "SUBMITTED_FOR_APPROVAL" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_00e43f43" } }, "description": "Current state of latest service profile change" }, "Change_2554fe61": { "required": [ "uuid", "type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER_UPDATE", "BGP_IPv4_PREFIX_FILTER_CREATION", "BGP_IPv4_PREFIX_FILTER_DELETION", "BGP_IPv6_PREFIX_FILTER_UPDATE", "BGP_IPv6_PREFIX_FILTER_CREATION", "BGP_IPv6_PREFIX_FILTER_DELETION" ], "type": "string", "description": "Type of change" }, "href": { "type": "string", "description": "Route filter change URI", "format": "uri" } }, "description": "Current state of latest route filter change" }, "Change_25b14a96": { "required": [ "createdDateTime", "data", "status", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "SERVICE_CREATION", "SERVICE_UPDATE", "SERVICE_DELETION" ], "type": "string" }, "status": { "type": "string", "description": "Current outcome of the change flow. Allowed values:\n- REQUESTED\n- SUBMITTED_FOR_APPROVAL\n- APPROVED\n- REJECTED\n- COMPLETED\n- FAILED\n", "format": "^(REQUESTED|SUBMITTED_FOR_APPROVAL|APPROVED|REJECTED|COMPLETED|FAILED)$" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "information": { "type": "string", "description": "Additional information" }, "data": { "required": [ "request", "service" ], "type": "object", "properties": { "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } }, "request": { "type": "string" } } } } }, "Change_28881cd4": { "required": [ "uuid", "type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION_UPDATE", "BGP_IPv4_PREFIX_AGGREGATION_CREATION", "BGP_IPv4_PREFIX_AGGREGATION_DELETION", "BGP_IPv6_PREFIX_AGGREGATION_UPDATE", "BGP_IPv6_PREFIX_AGGREGATION_CREATION", "BGP_IPv6_PREFIX_AGGREGATION_DELETION" ], "type": "string", "description": "Type of change" }, "href": { "type": "string", "description": "Route AGGREGATION Change URI", "format": "uri" } }, "description": "Current state of latest Route Aggregation change" }, "Change_36ac7b95": { "description": "Current state of latest service change", "anyOf": [ { "$ref": "#/components/schemas/Change_87bd954a" }, { "$ref": "#/components/schemas/Change_00fe696a" }, { "$ref": "#/components/schemas/Change_aa6d3c5e" }, { "$ref": "#/components/schemas/Change_042d43c7" }, { "$ref": "#/components/schemas/Change_df4e9dce" }, { "$ref": "#/components/schemas/Change_234a348c" } ] }, "Change_3a596f52": { "required": [ "type", "updatedDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "ROUTER_UPDATE" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_10fce732" } }, "description": "Current state of latest CloudRouter change" }, "Change_47ab42a6": { "required": [ "uuid", "type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE", "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION", "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION" ], "type": "string", "description": "Type of change" }, "href": { "type": "string", "description": "Route Aggregation Change URI", "format": "uri" } }, "description": "Current state of latest Route Aggregation Rule change" }, "Change_57d2fe6c": { "required": [ "data", "status", "type" ], "type": "object", "properties": { "status": { "type": "string", "default": "APPROVED" }, "data": { "required": [ "request", "service" ], "type": "object", "properties": { "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } }, "request": { "type": "string" } } } } }, "Change_63708aef": { "required": [ "data", "status", "type" ], "type": "object", "properties": { "status": { "type": "string", "default": "FAILED" }, "data": { "$ref": "#/components/schemas/Data_56f36f80" } } }, "Change_7b17b91f": { "required": [ "type", "updatedDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "APP_SUBSCRIPTION_UPDATE" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2026-06-29T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2026-06-29T07:15:00Z" }, "data": { "$ref": "#/components/schemas/Data_86460fc5" } }, "description": "Current state of latest AppSubscription change" }, "Change_7f4a8672": { "required": [ "uuid", "type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "ROUTING_PROTOCOL_UPDATE", "ROUTING_PROTOCOL_CREATION", "ROUTING_PROTOCOL_DELETION" ], "type": "string", "description": "Type of change" }, "href": { "type": "string", "description": "Routing Protocol Change URI", "format": "uri" } }, "description": "Current state of latest Routing Protocol change" }, "Change_83160f21": { "required": [ "type", "updatedDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "APP_LINK_UPDATE" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2026-06-29T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2026-06-29T07:15:00Z" }, "data": { "$ref": "#/components/schemas/Data_916fd1b7" } }, "description": "Current state of latest AppLink change" }, "Change_87bd954a": { "allOf": [ { "$ref": "#/components/schemas/Change_25b14a96" }, { "$ref": "#/components/schemas/Change_d695fafe" } ], "required": [ "status" ] }, "Change_979fb309": { "required": [ "uuid", "type" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE", "BGP_IPv4_PREFIX_FILTER_RULE_CREATION", "BGP_IPv4_PREFIX_FILTER_RULE_DELETION", "BGP_IPv6_PREFIX_FILTER_RULE_UPDATE", "BGP_IPv6_PREFIX_FILTER_RULE_CREATION", "BGP_IPv6_PREFIX_FILTER_RULE_DELETION" ], "type": "string", "description": "Type of change" }, "href": { "type": "string", "description": "Route Filter Change URI", "format": "uri" } }, "description": "Current state of latest route filter rule change" }, "Change_9942dbc0": { "required": [ "data", "status", "type" ], "type": "object", "properties": { "status": { "type": "string", "default": "COMPLETED" }, "data": { "required": [ "request", "service" ], "type": "object", "properties": { "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } }, "request": { "type": "string" } } } } }, "Change_aa6d3c5e": { "allOf": [ { "$ref": "#/components/schemas/Change_25b14a96" }, { "$ref": "#/components/schemas/Change_57d2fe6c" } ], "required": [ "status" ] }, "Change_aad47080": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "PORT_CREATION", "PORT_UPDATE", "PORT_DELETION" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_8223e945" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, "description": "Current state of latest port change" }, "Change_b615ff08": { "required": [ "data", "status", "type" ], "type": "object", "properties": { "status": { "type": "string", "default": "SUBMITTED_FOR_APPROVAL" }, "data": { "required": [ "request", "service" ], "type": "object", "properties": { "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } }, "request": { "type": "string" } } } } }, "Change_c09663d1": { "required": [ "type", "createdDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "CONNECTION_CREATION", "CONNECTION_UPDATE", "CONNECTION_DELETION", "CONNECTION_PROVIDER_STATUS_REQUEST" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "APPROVED", "COMPLETED", "FAILED", "REJECTED", "REQUESTED", "SUBMITTED_FOR_APPROVAL" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "information": { "type": "string", "description": "Additional information" }, "data": { "$ref": "#/components/schemas/Data_c55f2d51" } }, "description": "Current state of latest connection change" }, "Change_c53402e9": { "required": [ "data", "status", "type" ], "type": "object", "properties": { "status": { "type": "string", "default": "REJECTED" }, "data": { "$ref": "#/components/schemas/Data_db213e6e" } } }, "Change_cbb82a68": { "required": [ "type", "updatedDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "APP_DOMAIN_UPDATE" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2026-06-29T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2026-06-29T07:15:00Z" }, "data": { "$ref": "#/components/schemas/Data_e5b43534" } }, "description": "Current state of latest AppDomain change" }, "Change_d695fafe": { "required": [ "data", "status", "type" ], "type": "object", "properties": { "status": { "type": "string", "default": "REQUESTED" }, "data": { "required": [ "request", "service" ], "type": "object", "properties": { "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } }, "request": { "type": "string" } } } } }, "Change_df4e9dce": { "allOf": [ { "$ref": "#/components/schemas/Change_25b14a96" }, { "$ref": "#/components/schemas/Change_9942dbc0" } ], "required": [ "status" ] }, "Change_e362f715": { "required": [ "type", "updatedDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "APP_SERVICE_UPDATE" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2026-06-29T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2026-06-29T07:15:00Z" }, "data": { "$ref": "#/components/schemas/Data_916fd1b7" } }, "description": "Current state of latest AppLink change" }, "Change_e92ba39a": { "required": [ "type", "updatedDateTime" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Uniquely identifies a change" }, "type": { "enum": [ "APP_PROCESSOR_UPDATE" ], "type": "string", "description": "Type of change" }, "status": { "enum": [ "COMPLETED", "FAILED", "REQUESTED" ], "type": "string", "description": "Current outcome of the change flow" }, "createdDateTime": { "type": "string", "description": "Set when change flow starts", "format": "date-time", "example": "2026-06-29T07:00:00Z" }, "updatedDateTime": { "type": "string", "description": "Set when change object is updated", "format": "date-time", "example": "2026-06-29T07:15:00Z" }, "data": { "$ref": "#/components/schemas/Data_cef11c0f" } }, "description": "Current state of latest AppProcessor change" }, "Change_f9a00c8a": { "type": "object", "properties": { "uuid": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "createdDateTime": { "type": "string", "format": "date-time" }, "updatedDateTime": { "type": "string", "format": "date-time" }, "data": { "$ref": "#/components/schemas/Data_4d64e2a4" } } }, "Changelog": { "type": "object", "properties": { "createdBy": { "type": "string", "description": "Created by User Key", "example": "johnsmith" }, "createdDateTime": { "type": "string", "description": "Created by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "updatedBy": { "type": "string", "description": "Updated by User Key", "example": "johnsmith" }, "updatedDateTime": { "type": "string", "description": "Updated by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "deletedBy": { "type": "string", "description": "Deleted by User Key", "example": "johnsmith" }, "deletedDateTime": { "type": "string", "description": "Deleted by Date and Time", "format": "date-time", "example": "2020-11-06T07:00:00Z" } }, "description": "Change log" }, "Channel": { "type": "object", "properties": { "channelType": { "enum": [ "AWS_IOT_CORE", "WEBHOOK", "AZURE" ], "type": "string" }, "awsIotCoreChannelConfiguration": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "example": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com" } }, "description": "The configuration for an 'AWS_IOT_CORE' channel" }, "webhookChannelConfiguration": { "$ref": "#/components/schemas/WebhookChannelConfiguration" }, "azureChannelConfiguration": { "$ref": "#/components/schemas/AzureChannelConfiguration" } }, "description": "Subscription can be created using one channel." }, "ChargesItem_59d5ff28": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the charge, whether it is for the virtual device, the device license, or the additional bandwidth.", "example": "VIRTUAL_DEVICE" }, "monthlyRecurringCharges": { "type": "string", "description": "The monthly charges.", "example": "200" } }, "description": "Details of charges" }, "ChargesItem_9a3d62f8": { "required": [ "price", "type", "unit" ], "type": "object", "properties": { "type": { "enum": [ "MONTHLY_RECURRING", "NON_RECURRING" ], "type": "string", "description": "Charge type." }, "price": { "type": "number", "description": "Offering price" }, "unit": { "enum": [ "ITEM", "GB_1", "MBPS_1" ], "type": "string", "description": "In case of fixed billing the unit is ITEM" } }, "description": "Price Charge" }, "Charges_0805bf66": { "type": "array", "items": { "$ref": "#/components/schemas/ChargesItem_59d5ff28" } }, "Charges_26bcba3c": { "type": "array", "items": { "$ref": "#/components/schemas/ChargesItem_59d5ff28" }, "description": "An array of the monthly recurring charges." }, "CircuitCounts": { "type": "array", "items": { "type": "integer" }, "description": "Intra-Faciltiy Cable (IFC) circuit count options available for the respective connection service. E.g. If the 'circuitCount' is empty, it means there are no available IFC circuits. If '3,6' appears in the circuit count, it means that the IFC circuits options available are 3 circuits and 6 circuits.", "example": [ 1, 2 ] }, "CloudRouterExpression": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/CloudRouterExpressions" }, "or": { "$ref": "#/components/schemas/CloudRouterExpressions" }, "property": { "$ref": "#/components/schemas/SearchField" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `>` - greater than\n * `>=` - greater than or equal to\n * `<` - less than\n * `<=` - less than or equal to\n * `[NOT] BETWEEN` - (not) between\n * `[NOT] LIKE` - (not) like\n * `[NOT] IN` - (not) in\n * `ILIKE` - case-insensitive like\n" }, "values": { "type": "array", "items": { "type": "string" } } } }, "CloudRouterExpressions": { "type": "array", "items": { "$ref": "#/components/schemas/CloudRouterExpression" } }, "CloudRouterRouteAggregationAndExpression": { "type": "object", "properties": { "and": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CloudRouterRouteAggregationExpression" } } }, "description": "AND expression containing multiple filter expressions" }, "CloudRouterRouteAggregationExpression": { "anyOf": [ { "$ref": "#/components/schemas/CloudRouterRouteAggregationAndExpression" }, { "$ref": "#/components/schemas/CloudRouterRouteAggregationOrExpression" }, { "$ref": "#/components/schemas/CloudRouterRouteAggregationSimpleExpression" } ], "description": "Filter expression that can be AND, OR, or a simple expression" }, "CloudRouterRouteAggregationOrExpression": { "type": "object", "properties": { "or": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CloudRouterRouteAggregationExpression" } } }, "description": "OR expression containing multiple filter expressions" }, "CloudRouterRouteAggregationSimpleExpression": { "type": "object", "properties": { "property": { "enum": [ "/type", "/attachmentStatus", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string" }, "operator": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "CloudRouterRouteAggregationsFilter": { "anyOf": [ { "$ref": "#/components/schemas/CloudRouterRouteAggregationAndExpression" }, { "$ref": "#/components/schemas/CloudRouterRouteAggregationOrExpression" } ], "description": "Top-level filter that can be either an AND expression or OR expression" }, "CloudRouterRouteFilterAndExpression": { "type": "object", "properties": { "and": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CloudRouterRouteFilterExpression" } } }, "description": "AND expression containing multiple filter expressions" }, "CloudRouterRouteFilterExpression": { "anyOf": [ { "$ref": "#/components/schemas/CloudRouterRouteFilterAndExpression" }, { "$ref": "#/components/schemas/CloudRouterRouteFilterOrExpression" }, { "$ref": "#/components/schemas/CloudRouterRouteFilterSimpleExpression" } ], "description": "Filter expression that can be AND, OR, or a simple expression" }, "CloudRouterRouteFilterOrExpression": { "type": "object", "properties": { "or": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CloudRouterRouteFilterExpression" } } }, "description": "OR expression containing multiple filter expressions" }, "CloudRouterRouteFilterSimpleExpression": { "type": "object", "properties": { "property": { "enum": [ "/type", "/direction", "/attachmentStatus", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string" }, "operator": { "type": "string" }, "values": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "CloudRouterRouteFiltersFilter": { "anyOf": [ { "$ref": "#/components/schemas/CloudRouterRouteFilterAndExpression" }, { "$ref": "#/components/schemas/CloudRouterRouteFilterOrExpression" } ], "description": "Top-level filter that can be either an AND expression or OR expression" }, "CloudRouterSortBy": { "enum": [ "/name", "/uuid", "/state", "/location/metroCode", "/location/metroName", "/package/code", "/type", "/connectionsCount", "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/changeLog/deletedDateTime", "/order/termLength" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "CloudRouterSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "$ref": "#/components/schemas/CloudRouterSortBy" } } }, "CloudRouterSortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "ClusterDetails": { "type": "object", "properties": { "clusterName": { "type": "string", "description": "The cluster name.", "example": "My Cluster" }, "clusterNodeDetails": { "$ref": "#/components/schemas/ClusterNodeDetails" } }, "description": "Cluster configuration details" }, "ClusterNodeDetails": { "type": "object", "properties": { "node0": { "$ref": "#/components/schemas/Node0" }, "node1": { "$ref": "#/components/schemas/Node1" } }, "description": "Details of the nodes in a cluster" }, "ComparisonData": { "type": "object", "properties": { "datapoint": { "enum": [ "percentageKva" ], "type": "string", "description": "datapoint on which the comparison is done." }, "yesterday": { "type": "number", "description": "comparison for the current value of the datapoint with yesterday's value", "example": 0.147 }, "lastWeek": { "type": "number", "description": "comparison for the current value of the datapoint with last week's value", "example": -0.295 }, "lastMonth": { "type": "number", "description": "comparison for the current value of the datapoint with the last month's value", "example": -0.184 }, "lastQuarter": { "type": "number", "description": "comparison for the current value of the datapoint with the last quarter's value", "example": 52.434 } }, "description": "comparison of readings with the current reading for specified datapoint" }, "Condition": { "type": "object", "properties": { "conditionType": { "type": "string", "description": "The type of condition that triggers the alert (e.g., EXCEEDS, FALLS_BELOW)", "example": "EXCEEDS" }, "eventType": { "type": "string", "description": "The power metric being monitored (e.g., CAGE_DRAW, CABINET_DRAW_TO_USABLE_KVA)", "example": "CAGE_DRAW" }, "threshold": { "$ref": "#/components/schemas/Threshold" } }, "description": "Defines the condition that triggers a power alert" }, "Configuration": { "type": "object", "properties": { "thresholdValue": { "type": "string", "description": "threshold value", "example": "0" }, "thresholdValueDisplayName": { "type": "string", "description": "threshold display value", "example": "ALARM" }, "unitOfMeasurement": { "type": "string", "description": "unit of measurement", "example": "i.e °C" }, "thresholdType": { "enum": [ "DIGITAL", "ABSOLUTE", "DEVIATION", "MULTI_STATE" ], "type": "string", "description": "threshold type", "example": "DIGITAL" }, "conditionName": { "enum": [ "ALARM", "WARNING", "VERY_LOW", "LOW", "HIGH", "VERY_HIGH" ], "type": "string", "description": "condition name", "example": "ALARM" }, "customerVisible": { "type": "boolean", "description": "asset is customer visible", "example": false }, "configurationVersion": { "type": "string", "description": "alert configuration version", "example": "1.0" } } }, "ConnectedMetros": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedMetrosItem" } }, "ConnectedMetrosItem": { "type": "object", "properties": { "href": { "type": "string", "description": "The Canonical URL at which the resource resides." }, "code": { "type": "string", "description": "Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area." }, "avgLatency": { "type": "number", "description": "Average latency (in milliseconds[ms]) between two specified metros." }, "remoteVCBandwidthMax": { "type": "integer", "description": "This field holds the Max Connection speed with connected metros", "format": "int64" } }, "description": "Arrays of objects containing latency data for the specified metros" }, "ConnectionDestinationType": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side.\n", "example": "COLO" }, "Connection_aa288f10": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" }, "href": { "type": "string", "example": "https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4" }, "type": { "enum": [ "EVPL_VC", "EPL_VC", "EC_VC", "IP_VC", "ACCESS_EPL_VC", "EIA_VC", "EVPLAN_VC", "EPLAN_VC", "EVPTREE_VC", "EPTREE_VC", "IPWAN_VC", "IA_VC", "MC_VC", "IX_VC", "GW_VC", "IPX_VC" ], "type": "string", "description": "Connection type" }, "operation": { "$ref": "#/components/schemas/Operation_b2cbabaa" } }, "description": "Connection object for router actions" }, "Connection_dd127cea": { "type": "object", "properties": { "type": { "enum": [ "EVPL_VC", "EPL_VC", "EVPLAN_VC", "EPLAN_VC", "IPWAN_VC", "IP_VC", "EVPTREE_VC", "EPTREE_VC" ], "type": "string", "description": "Type of Connection" }, "href": { "type": "string", "description": "An absolute URL that is the subject of the link's context.", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned connection identifier", "format": "uuid" }, "allowRemoteConnection": { "type": "boolean", "description": "Authorization to connect remotely", "default": false }, "allowCustomBandwidth": { "type": "boolean", "description": "Allow custom bandwidth value", "default": false }, "bandwidthLimit": { "maximum": 100000.0, "minimum": 0.0, "type": "integer", "description": "Connection bandwidth limit in Mbps" }, "supportedBandwidths": { "type": "array", "items": { "type": "integer" }, "description": "List of permitted bandwidths." }, "aSide": { "$ref": "#/components/schemas/ASide_9935d2e1" }, "zSide": { "$ref": "#/components/schemas/ASide_9935d2e1" } }, "description": "Service Token Connection Type Information" }, "ConnectionsItem_076d1d44": { "required": [ "aSide", "bandwidth", "changeLog", "links", "name", "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "uuid": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "type": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "description": "Connection type. IA_C - internet access connection on dedicated port; IA_VC - internet access virtual connection on Fabric Port, Virtual Device, Bare Metal, etc." }, "name": { "type": "string", "description": "Name of the connection", "example": "Primary Connection LD1" }, "description": { "type": "string", "description": "Description of the connection", "example": "Primary connection in LD1 location" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "bandwidth": { "minimum": 1000.0, "type": "integer", "description": "Bandwidth of the Connection in Mbps", "format": "int64", "example": 1000 }, "redundancy": { "$ref": "#/components/schemas/Redundancy_4c4282fd" }, "aSide": { "$ref": "#/components/schemas/ASide_dfb7151e" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] }, "links": { "$ref": "#/components/schemas/Links_8561166d" } } }, "ConnectionsItem_4861a470": { "required": [ "href", "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Ip block URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1" }, "uuid": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "type": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "description": "Connection type. IA_C - internet access connection on dedicated port; IA_VC - internet access virtual connection on Fabric Port, Virtual Device, Bare Metal, etc." } } }, "ConnectionsItem_971d234a": { "required": [ "href", "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Ip block URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1" }, "uuid": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" } } }, "ConnectionsItem_bfd51ba6": { "required": [ "href", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the connection", "format": "uri" }, "uuid": { "type": "string", "description": "Unique identifier for the connection", "format": "uuid" }, "peeringIpv4": { "$ref": "#/components/schemas/PeeringIpv4" }, "peeringIpv6": { "$ref": "#/components/schemas/PeeringIpv6" } } }, "ConnectionsItem_e5b037ff": { "required": [ "aSide", "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "type": { "enum": [ "IA_C", "IA_VC" ], "type": "string", "example": "IA_C", "x-enum-varnames": [ "IA_C", "IA_VC" ] }, "aSide": { "required": [ "service", "type" ], "type": "object", "properties": { "type": { "type": "string" }, "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } } } } } }, "ConnectionsItem_e5ce0fc6": { "allOf": [ { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" } } }, { "$ref": "#/components/schemas/ConnectionsItem_e5b037ff" } ] }, "Connections_1076dd05": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsItem_bfd51ba6" } }, "Connections_463653ff": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsItem_971d234a" } }, "Connections_73eaa6a1": { "maxItems": 2, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FabricConnectionResponse" }, "description": "Fabric Connections associated with Precision Time Service." }, "Connections_a8ffb32b": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsItem_e5ce0fc6" } }, "Connections_d0aafdac": { "type": "array", "items": { "$ref": "#/components/schemas/FabricConnectionUuid" } }, "Connections_ed416f2a": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionsItem_4861a470" } }, "Contact_Info_12bbde9b": { "title": "Contact Info", "required": [ "contactType" ], "type": "object", "properties": { "contactType": { "enum": [ "TECHNICAL", "ORDERING", "NOTIFICATION" ], "type": "string", "description": "Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL", "example": "TECHNICAL" }, "userName": { "minLength": 1, "type": "string", "description": "User Name" }, "name": { "pattern": "^[\\s.]*([^\\s.][\\s.]*){0,100}$", "type": "string", "description": "Technical Contact Name", "example": "David" }, "email": { "title": "emailDef", "pattern": "^(([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$", "type": "string", "description": "Contact Email", "example": "toanupdixit@gmail.com" }, "workPhoneCountryCode": { "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Primary Phone of the contact", "example": "+1" }, "workPhone": { "maxLength": 40, "type": "string", "description": "Primary Phone of the contact", "example": "111-111-1111" }, "workPhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "mobilePhoneCountryCode": { "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Mobile Phone of the contact", "example": "+1" }, "mobilePhone": { "maxLength": 40, "type": "string", "description": "Mobile Phone of the contact", "example": "111-111-1112" }, "mobilePhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "workPhoneTimeZone": { "maxLength": 40, "type": "string", "description": "Work Phone TimeZone", "example": "America/LosAngeles" }, "mobilePhoneTimeZone": { "maxLength": 40, "type": "string", "description": "Mobile Phone TimeZone", "example": "America/LosAngeles" } } }, "Contact_Info_4b42a509": { "title": "Contact Info", "required": [ "contactType" ], "type": "object", "properties": { "contactType": { "enum": [ "TECHNICAL", "ORDERING", "NOTIFICATION" ], "type": "string", "description": "Contact Type, possible values are ORDERING, NOTIFICATION, TECHNICAL", "example": "TECHNICAL" }, "userName": { "type": "string", "description": "User Name", "example": "kmo00re@abc.com" }, "name": { "pattern": "^[\\s.]*([^\\s.][\\s.]*){0,100}$", "type": "string", "description": "Full Name of the Contact, Eg. 'First_Name' + 'Last_Name'", "example": "Jane Smith" }, "email": { "maxLength": 100, "pattern": "^(([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$", "type": "string", "description": "Valid email address of the contact" }, "workPhoneCountryCode": { "maxLength": 6, "minLength": 1, "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Country Code of Primary Phone of the contact" }, "workPhone": { "maxLength": 40, "minLength": 1, "pattern": "^[0-9\\.\\-() ]{2,40}(?:(x|ext)[0-9\\.\\-() ]{1,10})?$", "type": "string", "description": "Primary Phone of the contact" }, "workPhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "mobilePhoneCountryCode": { "maxLength": 6, "minLength": 1, "pattern": "^\\+[0-9]{1,6}$", "type": "string", "description": "Country Code of Mobile Phone of the contact" }, "mobilePhone": { "maxLength": 40, "minLength": 1, "pattern": "^[0-9\\.\\-() ]{2,40}(?:(x|ext)[0-9\\.\\-() ]{1,10})?$", "type": "string", "description": "Mobile Phone of the contact" }, "mobilePhonePrefToCall": { "enum": [ "NEVER", "ANYTIME", "MY_BUSINESS_HOURS", "IBX_BUSINESS_HOURS", "BUSINESS_HOURS" ], "type": "string", "description": "Possible values are NEVER, ANYTIME, BUSINESS_HOURS, MY_BUSINESS_HOURS,IBX_BUSINESS_HOURS. But BUSINESS_HOURS is deprecated and will be removed in future release", "example": "ANYTIME" }, "workPhoneTimeZone": { "maxLength": 40, "type": "string", "description": "Work Phone TimeZone", "example": "America/LosAngeles" }, "mobilePhoneTimeZone": { "maxLength": 40, "type": "string", "description": "Mobile Phone TimeZone", "example": "America/LosAngeles" } }, "description": "Use this model to build contact object. Ordering and notification contacts are are always equinix registered contacts and we only expect username and rest of the details will be looked up. It is important to know that when username is provided all other attributes apart from contactType will be ignored ", "example": { "contactType": "TECHNICAL", "name": "Jane Smith", "email": "jane_smith@test.com", "workPhoneCountryCode": "+1", "workPhone": "408123456", "workPhonePrefToCall": "ANYTIME", "mobilePhoneCountryCode": "+1", "mobilePhone": "408123456", "mobilePhonePrefToCall": "ANYTIME" } }, "ContactsItem_3487b66d": { "required": [ "firstName", "lastName", "details", "type" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact.", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the contact.", "example": "Doe" }, "type": { "enum": [ "TECHNICAL" ], "type": "string", "description": "Note that only one technical contact is allowed.", "default": "TECHNICAL" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Contact's availability to receive calls.", "default": "ANYTIME" }, "timezone": { "$ref": "#/components/schemas/Timezone_83d81d7f" }, "details": { "$ref": "#/components/schemas/Details_7211ffcd" } }, "description": "Contact information of a non-registered contact, including contact details." }, "ContactsItem_761f0a79": { "anyOf": [ { "$ref": "#/components/schemas/ContactsItem_e7632520" }, { "$ref": "#/components/schemas/ContactsItem_3487b66d" } ] }, "ContactsItem_78ce6c57": { "required": [ "registeredUsers" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "type": "array", "items": { "type": "string", "example": "john_doe1" }, "description": "Username of a registered user." } }, "description": "Contact information of a registered user. Ensure that the user status of this contact is approved or active." }, "ContactsItem_7d25ee7d": { "required": [ "registeredUsers", "type" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string", "example": "john_doe" }, "description": "Username for the registered user party" }, "type": { "enum": [ "NOTIFICATION" ], "type": "string", "description": "Type of contact" } }, "description": "Contact information." }, "ContactsItem_d75ba821": { "required": [ "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "Account URI", "example": "https://api.equinix.com/access/v2/users/john_doe" }, "type": { "enum": [ "NOTIFICATION", "TECHNICAL", "ORDERING", "RESELLING", "BILLING" ], "type": "string", "description": "Contact type", "example": "ORDERING" }, "registeredUser": { "type": "string", "description": "Identifies (e.g., contactId, userId, userKey) a registered user.\n", "example": "john_doe" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "timezone": { "type": "string", "example": "Pacific" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME", "CUSTOMER_BUSINESS_HOURS", "NOT_AVAILABLE" ], "type": "string", "example": "WORK_HOURS" }, "notes": { "type": "string", "description": "Describe any contact preferences\n", "example": "For urgent cases please make a phone call." }, "details": { "$ref": "#/components/schemas/Details_82399dd0" } } }, "ContactsItem_e7632520": { "required": [ "registeredUsers", "type" ], "type": "object", "properties": { "registeredUsers": { "maxItems": 10, "type": "array", "items": { "type": "string", "example": "john_doe" }, "description": "Username of a registered user." }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Contact's availability to receive calls.", "default": "ANYTIME" }, "timezone": { "$ref": "#/components/schemas/Timezone_83d81d7f" }, "type": { "enum": [ "NOTIFICATION", "TECHNICAL" ], "type": "string", "description": "Note that only one technical contact is allowed.", "default": "NOTIFICATION" } }, "description": "Contact information of a registered user. Ensure that the user status of this contact is approved, active or locked." }, "ContactsItem_f4f79639": { "required": [ "details", "type" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "TECHNICAL", "ORDERING", "RESELLING", "BILLING" ], "type": "string", "description": "Notification messages category relevant to a given contact person.", "example": "NOTIFICATION" }, "registeredUser": { "type": "string", "description": "Registered user identified by contactId, userId, or userKey. If a registered user is specified, you don't have to provide first name and last name information.", "example": "Registered" }, "firstName": { "type": "string", "description": "Contact person's first name. Required if registeredUser isn't provided.", "example": "John" }, "lastName": { "type": "string", "description": "Contact person's last name. Required if registeredUser isn't provided.", "example": "Smith" }, "timezone": { "type": "string", "description": "Contact Timezone", "example": "Australia/Perth" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Contact person's availability.", "example": "ANYTIME" }, "details": { "$ref": "#/components/schemas/Details_ed303304" } }, "description": "Contact interface" }, "Contacts_4a0177e7": { "type": "array", "items": { "$ref": "#/components/schemas/ContactsItem_761f0a79" } }, "Contacts_b1e4be6d": { "type": "array", "items": { "$ref": "#/components/schemas/ContactsItem_d75ba821" } }, "Contacts_be02ebcc": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ContactsItem_f4f79639" }, "description": "Organization contact information." }, "Contacts_d5d3518a": { "maxItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ContactsItem_7d25ee7d" } }, "Contacts_fde38a92": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Contact_Info_12bbde9b" } }, "Core": { "type": "object", "properties": { "core": { "type": "integer", "description": "Number of cores.", "example": 4 }, "memory": { "type": "integer", "description": "The amount of memory.", "example": 4 }, "unit": { "type": "string", "description": "The unit of memory.", "example": "GB" }, "tier": { "type": "integer", "description": "Tier is only relevant for Cisco8000V devices.", "example": 2 } }, "description": "Core configuration details" }, "CountryCode_3a211f7f": { "enum": [ "AX", "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CD", "CG", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "JM", "JP", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "CS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VA", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "`ISO-3166 ALPHA-2` Country code. Country code of customer legal entity.", "example": "US" }, "CountryCode_46c0fb03": { "enum": [ "AX", "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CD", "CG", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "JM", "JP", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "CS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VA", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "`ISO-3166 ALPHA-2` Country code.", "example": "US" }, "Credential": { "type": "object", "properties": { "type": { "enum": [ "ACCESS_TOKEN", "INTEGRATION_KEY", "API_KEY", "USERNAME_PASSWORD", "API_TOKEN" ], "type": "string", "description": "credential type" }, "accessToken": { "type": "string", "description": "passed as Authorization header value" }, "integrationKey": { "type": "string", "description": "passed as Authorization header value" }, "apiKey": { "type": "string", "description": "passed as Authorization header value" }, "username": { "type": "string", "description": "passed as Authorization header value" }, "password": { "type": "string", "description": "passed as Authorization header value" }, "apiToken": { "type": "string", "description": "passed as Authorization header value" } }, "description": "Stream subscription sink credentials" }, "CrossConnect": { "required": [ "connectionService", "mediaType", "protocolType", "zSide" ], "type": "object", "properties": { "connectionService": { "type": "string", "description": "Connection service type. For applicable values, use the Equinix Customer Portal - Lookup - Get Patch Panel Details API request.", "example": "MULTI_MODE_FIBER" }, "mediaType": { "type": "string", "description": "Media type. For applicable values, use the Equinix Customer Portal - Lookup - Get Patch Panel Details API request.", "example": "50_MICRON_MULTI_MODE_FIBER_OM3" }, "protocolType": { "type": "string", "description": "Connection protocol. For applicable values, use the Equinix Customer Portal - Lookup - Get Patch Panel Details API request.", "example": "100_GIG_ETHERNET" }, "aSide": { "$ref": "#/components/schemas/ASide_d11a90e8" }, "zSide": { "$ref": "#/components/schemas/ASide_d11a90e8" } }, "description": "Cross Connect interface" }, "CrossConnectASideRequest": { "title": "CrossConnectASideRequest", "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_48e2f663" } }, "description": "A-Side connection details." }, "CrossConnectASideResponse": { "title": "CrossConnectASideResponse", "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_a5cf3909" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code.", "example": "SV1" } }, "description": "Cross Connect Location details." } }, "description": "A-Side connection details." }, "CrossConnectZSideRequest": { "title": "CrossConnectZSideRequest", "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_a8552e97" }, "location": { "allOf": [ { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code.", "example": "SV1" } }, "description": "Cross Connect Location details." } ], "description": "Required when connecting to a BMMR." }, "loa": { "$ref": "#/components/schemas/Loa_22cb5cff" } }, "description": "Z-Side connection details. Provide the demarcationPoint for a patch panel to patch panel Cross Connect, or location when connecting to a BMMR. loa is mandatory for a Cross Connect with LOA and when bmmrType is EQUINIX - provide either loa.uuid or loa.digitalLoaId.\n" }, "CrossConnectZSideResponse": { "title": "CrossConnectZSideResponse", "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_a96011a1" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code.", "example": "SV1" } }, "description": "Cross Connect Location details." }, "loa": { "$ref": "#/components/schemas/Loa_bcb2e03a" } }, "description": "Z-Side connection details." }, "Currency": { "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "type": "string", "description": "Currency codes", "example": "USD" }, "Currency_Code": { "title": "Currency Code", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ], "type": "string", "description": "`ISO-4217` currency code" }, "CustomAlert": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAlertItem" }, "description": "List of custom alert message type to subscribe" }, "CustomAlertItem": { "required": [ "accountNumber", "ibx" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "135888" }, "ibx": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "user": { "type": "string" } }, "description": "Custom Alert messages are sent when user-defined alert conditions become true. The message contains the data point value that triggered the alert." }, "CustomFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldsItem" } }, "CustomFieldsItem": { "required": [ "label", "required", "dataType" ], "properties": { "label": { "type": "string", "example": "Account Number" }, "description": { "type": "string", "example": "Provide a valid account number" }, "required": { "type": "boolean", "example": true }, "dataType": { "enum": [ "STRING", "LIST", "NUMBER" ], "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "captureInEmail": { "type": "boolean", "description": "capture this field as a part of email notification" } }, "description": "Define Custom Attributes" }, "CustomerDetails": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Customer account name", "example": "Account name" }, "accountNumber": { "type": "string", "description": "Customer account number", "example": "123456" }, "region": { "enum": [ "APAC", "AMER", "EMEA" ], "type": "string", "description": "This is the region code of Equinix Legal Entity" } } }, "CustomerReferenceNumber": { "maxLength": 50, "minLength": 1, "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "example": "cust-ref-123" }, "CustomerRoute": { "required": [ "ipBlock" ], "type": "object", "properties": { "ipBlock": { "$ref": "#/components/schemas/IpBlock_a884a7c2" } } }, "CustomerRoutesItem_01576e0c": { "allOf": [ { "$ref": "#/components/schemas/CustomerRoutesItem_efeab853" }, { "$ref": "#/components/schemas/CustomerRoutesItem_937876c8" } ], "required": [ "importPolicy" ] }, "CustomerRoutesItem_12559fc9": { "anyOf": [ { "$ref": "#/components/schemas/CustomerRoutesItem_c8948be0" }, { "$ref": "#/components/schemas/CustomerRoutesItem_801bbbaf" } ] }, "CustomerRoutesItem_362eb3a7": { "required": [ "importPolicy", "prefixLength" ], "type": "object", "properties": { "importPolicy": { "type": "object" }, "prefix": { "$ref": "#/components/schemas/Prefix_d1c3332c" }, "prefixLength": { "maximum": 128.0, "minimum": 1.0, "type": "integer", "description": "Determines the size of ip subnet", "example": 64 }, "ipBlock": { "$ref": "#/components/schemas/IpBlock_f7a51638" } } }, "CustomerRoutesItem_45893645": { "required": [ "importPolicy", "ipBlock" ], "properties": { "importPolicy": { "type": "string", "default": "PA" }, "ipBlock": { "$ref": "#/components/schemas/IpBlock_9befaff9" } } }, "CustomerRoutesItem_756a7161": { "allOf": [ { "$ref": "#/components/schemas/CustomerRoutesItem_efeab853" }, { "$ref": "#/components/schemas/CustomerRoutesItem_45893645" } ], "required": [ "importPolicy" ] }, "CustomerRoutesItem_76755bb9": { "required": [ "importPolicy", "ipBlock" ], "properties": { "importPolicy": { "type": "string", "default": "PA" }, "ipBlock": { "$ref": "#/components/schemas/IpBlock_8102651f" } } }, "CustomerRoutesItem_801bbbaf": { "required": [ "importPolicy" ], "allOf": [ { "$ref": "#/components/schemas/CustomerRoutesItem_efeab853" }, { "required": [ "prefix" ], "type": "object", "properties": { "prefix": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:/[0-2]*\\d{1}|/3[0-2]){1}$", "type": "string", "description": "Subnet prefix", "example": "198.51.100.0/24" } } } ], "properties": { "importPolicy": { "type": "string", "default": "PI" } } }, "CustomerRoutesItem_88a6d342": { "anyOf": [ { "$ref": "#/components/schemas/CustomerRoutesItem_756a7161" }, { "$ref": "#/components/schemas/CustomerRoutesItem_01576e0c" } ] }, "CustomerRoutesItem_8b5311ca": { "required": [ "importPolicy", "prefixLength" ], "type": "object", "properties": { "importPolicy": { "type": "object" }, "prefix": { "pattern": "^([01]?\\d\\d?|2[0-4]\\d|25[0-5])(?:\\.(?:[01]?\\d\\d?|2[0-4]\\d|25[0-5])){3}(?:/[0-2]\\d|/3[0-2])+$", "type": "string", "description": "Subnet prefix\n" }, "prefixLength": { "maximum": 32.0, "minimum": 1.0, "type": "integer", "description": "Determines the size of ip subnet", "example": 30 }, "ipBlock": { "$ref": "#/components/schemas/IpBlock_f7a51638" } } }, "CustomerRoutesItem_937876c8": { "required": [ "importPolicy", "prefix" ], "properties": { "importPolicy": { "type": "string", "default": "PI" }, "prefix": { "$ref": "#/components/schemas/Prefix_bc7323fe" } } }, "CustomerRoutesItem_9a404b5b": { "type": "object", "properties": { "ipBlock": { "allOf": [ { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } }, { "required": [ "prefixLength" ], "type": "object", "properties": { "prefixLength": { "maximum": 126.0, "minimum": 48.0, "type": "integer", "description": "Length of the IP block, number after the / (slash)\n" } } } ] }, "prefix": { "$ref": "#/components/schemas/Prefix_bc7323fe" } } }, "CustomerRoutesItem_c8948be0": { "allOf": [ { "$ref": "#/components/schemas/CustomerRoutesItem_efeab853" }, { "$ref": "#/components/schemas/CustomerRoutesItem_76755bb9" } ], "required": [ "importPolicy" ] }, "CustomerRoutesItem_e1524eca": { "type": "object", "properties": { "ipBlock": { "$ref": "#/components/schemas/IpBlock_083ee67b" }, "prefix": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:/[0-2]*\\d{1}|/3[0-2]){1}$", "type": "string", "description": "Subnet prefix", "example": "198.51.100.0/24" } } }, "CustomerRoutesItem_efeab853": { "required": [ "importPolicy" ], "type": "object", "properties": { "importPolicy": { "pattern": "^(PA|PI)$", "type": "string", "description": "Provider Assigned (PA) means that Equinix will assign ip address space. Provider Independent (PI) means that the API caller must supply ip address space. Allowed values: PA, PI\n" } } }, "CustomerRoutes_63d0810d": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CustomerRoutesItem_88a6d342" } }, "CustomerRoutes_6a006ab5": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CustomerRoutesItem_e1524eca" }, "description": "Collection of customer routes of IP Version 4 (IPv4)" }, "CustomerRoutes_77dd959b": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CustomerRoutesItem_9a404b5b" }, "description": "Collection of customer routes of IP Version 6 (IPv6)" }, "CustomerRoutes_99fdcee7": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CustomerRoutesItem_362eb3a7" } }, "CustomerRoutes_9e613813": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CustomerRoutesItem_8b5311ca" } }, "CustomerRoutes_cb50380e": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CustomerRoutesItem_12559fc9" } }, "Customer_Reference_Number": { "title": "Customer Reference Number", "maxLength": 50, "minLength": 1, "type": "string", "description": "You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this information to search for this content on the submitted requests page.", "example": "RSS41244" }, "DataItem_01b53787": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "operation type applied to the resource" }, "path": { "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter", "x-go-type": "json.RawMessage" } }, "description": "App Subscription change operation data" }, "DataItem_034e7d0f": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "operation type applied to the resource" }, "path": { "enum": [ "/description" ], "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter", "x-go-type": "json.RawMessage" } }, "description": "App Domain change operation data" }, "DataItem_062179d0": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "BGP", "DIRECT" ], "type": "string", "description": "Routing protocol type" } }, "anyOf": [ { "$ref": "#/components/schemas/DataItem_efe40161" }, { "$ref": "#/components/schemas/DataItem_8d896f90" } ] }, "DataItem_07afdb02": { "required": [ "type", "name", "bandwidth", "aSide", "zSide" ], "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "uri" }, "type": { "enum": [ "EVPL_VC", "EPL_VC", "EC_VC", "IP_VC", "ACCESS_EPL_VC", "EIA_VC", "EVPLAN_VC", "EPLAN_VC", "EVPTREE_VC", "EPTREE_VC", "IPWAN_VC", "IA_VC", "MC_VC", "IX_VC", "GW_VC", "IPX_VC" ], "type": "string", "description": "Connection type" }, "uuid": { "type": "string", "description": "Equinix-assigned connection identifier" }, "name": { "type": "string", "description": "Customer-provided connection name" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "change": { "$ref": "#/components/schemas/Change_c09663d1" }, "operation": { "$ref": "#/components/schemas/Operation_e2c43536" }, "order": { "$ref": "#/components/schemas/Order_3e7328e1" }, "notifications": { "$ref": "#/components/schemas/Notifications_903ff2b6" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "bandwidth": { "maximum": 10000.0, "minimum": 0.0, "type": "integer", "description": "Connection bandwidth in Mbps" }, "geoScope": { "enum": [ "CANADA", "CONUS", "JAPAN", "UK", "AUSTRALIA", "BRAZIL", "SWITZERLAND", "EU" ], "type": "string", "description": "Geographic boundary for this connection" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_03b2b702" }, "isRemote": { "type": "boolean", "description": "Connection property derived from access point locations" }, "direction": { "enum": [ "INTERNAL", "INCOMING", "OUTGOING" ], "type": "string", "description": "Connection directionality from the requester point of view" }, "aSide": { "$ref": "#/components/schemas/ASide_cdc3f780" }, "zSide": { "$ref": "#/components/schemas/ASide_cdc3f780" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" }, "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Connection additional information" }, "project": { "$ref": "#/components/schemas/Project_12b4cec8" } }, "description": "Connection specification" }, "DataItem_0b2bd7bb": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Aggregation URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION" ], "type": "string", "description": "Route Aggregation type" }, "uuid": { "type": "string", "description": "Route Aggregation identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHED", "DETACHED", "DETACHING", "FAILED", "PENDING_BGP_CONFIGURATION" ], "type": "string" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } }, "DataItem_0e6dd2e7": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "operation type applied to the resource" }, "path": { "enum": [ "/name", "/description", "/sourceDomains" ], "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter", "x-go-type": "json.RawMessage" } }, "description": "App Service change operation data" }, "DataItem_1406f4be": { "type": "object", "description": "Service Profile Access Points", "anyOf": [ { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "add" ], "type": "string" }, "path": { "type": "string", "description": "A JSON Pointer path." }, "value": { "type": "object", "description": "value to add" } }, "description": "Add Sub-Resource to the existing model" }, { "required": [ "op", "path" ], "type": "object", "properties": { "op": { "enum": [ "remove" ], "type": "string" }, "path": { "type": "string", "description": "A JSON Pointer path." } }, "description": "Remove sub-resource from an existing model" }, { "$ref": "#/components/schemas/DataItem_699ec854" } ] }, "DataItem_150a893e": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter" } }, "description": "Fabric Cloud Router change operation data" }, "DataItem_1a4953ef": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream Subscription URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "STREAM_SUBSCRIPTION" ], "type": "string", "description": "type" }, "name": { "type": "string", "description": "Customer-provided subscription name" }, "description": { "type": "string", "description": "Customer-provided subscription description" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "REPROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string", "description": "Steam subscription provision state" }, "enabled": { "type": "boolean", "description": "Stream subscription enabled status" }, "metricSelector": { "$ref": "#/components/schemas/MetricSelector" }, "eventSelector": { "$ref": "#/components/schemas/MetricSelector" }, "sink": { "$ref": "#/components/schemas/Sink_2cb28b2c" }, "operation": { "$ref": "#/components/schemas/Operation_4b006c02" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Stream Subscription object" }, "DataItem_1eef7681": { "type": "object", "properties": { "href": { "type": "string", "description": "Cross Connect URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743" }, "type": { "enum": [ "XC" ], "type": "string", "description": "Type of Cross Connect.", "example": "XC" }, "uuid": { "type": "string", "description": "Cross Connect Identifier.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" }, "name": { "type": "string", "description": "A short, descriptive name for this Cross Connect.", "example": "My-CC-service" }, "state": { "enum": [ "PENDING", "PENDING_ACTION", "PROVISIONING", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONED", "CANCELLING", "CANCELLED", "FAILED" ], "type": "string", "description": "Cross Connect State.", "example": "PENDING" }, "allowedActions": { "$ref": "#/components/schemas/AllowedActions" }, "bmmrType": { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "Cross Connect BMMR Type.", "example": "EQUINIX" }, "mediaType": { "type": "string", "description": "Media type of the Cross Connect.", "example": "SINGLE_MODE_FIBER" }, "mediaSubType": { "type": "string", "description": "Media sub-type of the Cross Connect.", "example": "SINGLE_MODE_FIBER" }, "circuitId": { "type": "string", "description": "Circuit identifier of the Cross Connect." }, "serialNumber": { "type": "string", "description": "Serial number of the Cross Connect.", "example": "234567890" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_b237089f" }, "aSide": { "$ref": "#/components/schemas/CrossConnectASideResponse" }, "zSide": { "$ref": "#/components/schemas/CrossConnectZSideResponse" }, "account": { "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account number.", "format": "int64", "example": 123456 } }, "description": "Account the Cross Connect belongs to." }, "notifications": { "$ref": "#/components/schemas/Notifications_7cbe42a5" }, "order": { "$ref": "#/components/schemas/Order_41b238f5" }, "links": { "$ref": "#/components/schemas/Links_b5ec80bd" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_a9aa0994" } }, "description": "Cross Connect Response." }, "DataItem_22ddc33e": { "type": "object", "properties": { "type": { "type": "string", "description": "Equinix supported metric type" }, "name": { "type": "string", "description": "Metric name" }, "unit": { "type": "string", "description": "Metric unit" }, "interval": { "type": "string", "description": "Metric interval (set automatically based on search range)" }, "resource": { "$ref": "#/components/schemas/Resource_6fef64a2" }, "summary": { "type": "string", "description": "Metric summary" }, "datapoints": { "$ref": "#/components/schemas/Datapoints" } }, "description": "Metric object" }, "DataItem_2cd3d0bb": { "type": "object", "properties": { "href": { "type": "string", "description": "Route filter URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER", "BGP_IPv6_PREFIX_FILTER" ], "type": "string", "description": "Route filter type" }, "uuid": { "type": "string", "description": "Route Filter identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHED", "DETACHED", "DETACHING", "FAILED", "PENDING_BGP_CONFIGURATION" ], "type": "string" }, "direction": { "enum": [ "INBOUND", "OUTBOUND" ], "type": "string" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } }, "DataItem_2f250477": { "type": "object", "properties": { "href": { "type": "string", "description": "URI of this Optical Connect resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0" }, "uuid": { "type": "string", "description": "Unique identifier of this Optical Connect.", "format": "uuid", "example": "06dbb0e3-e55d-4090-8aff-fc5654abaad0" }, "type": { "enum": [ "OC" ], "type": "string", "description": "Connection Type.
OC - Optical Connect.\n", "example": "OC" }, "name": { "type": "string", "description": "Equinix-assigned name, derived from the account number and the two IBX locations.\n", "example": "123456-SV1-SV2-01" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "PROVISIONING_FAILED", "REPROVISIONING", "REPROVISIONING_FAILED", "DEPROVISIONING", "DEPROVISIONED" ], "type": "string", "description": "Optical Connect lifecycle states.", "example": "PROVISIONED" }, "bandwidth": { "type": "integer", "description": "Provisioned connection bandwidth in Mbps.", "example": 10000 }, "connectionDestinationType": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
\n" }, "pathType": { "$ref": "#/components/schemas/PathType_2d3cf468" }, "bmmrType": { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.\n" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_e8c4a2d1" }, "aSide": { "$ref": "#/components/schemas/ASide_cc9f4f57" }, "zSide": { "$ref": "#/components/schemas/ZSide_def831f6" }, "order": { "$ref": "#/components/schemas/Order_95704d9c" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_57addba0" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Optical Metro Connect connection with its current state and the resolved\n physical termination points at both ends." }, "DataItem_59eff7ff": { "type": "object", "properties": { "href": { "type": "string", "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", "format": "uri" }, "type": { "enum": [ "XF_PHYSICAL_PORT" ], "type": "string", "description": "Type of Port" }, "id": { "type": "integer", "description": "Equinix assigned response attribute for Physical Port Id" }, "state": { "enum": [ "PENDING", "PROVISIONING", "REPROVISIONING", "PENDING_CROSS_CONNECT", "PROVISIONED", "ACTIVE", "DEPROVISIONING", "DEPROVISIONED", "INACTIVE", "FAILED", "ADDED", "DELETED", "TO_BE_ADDED", "TO_BE_DELETED" ], "type": "string", "description": "Port lifecycle state" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "interfaceSpeed": { "minimum": 0.0, "type": "integer", "description": "Physical Port Speed in Mbps" }, "interfaceType": { "type": "string", "description": "Physical Port Interface Type" }, "uuid": { "type": "string", "description": "Equinix assigned response attribute for physical port identifier", "format": "uuid" }, "tether": { "$ref": "#/components/schemas/Tether" }, "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_970747e9" }, "notifications": { "$ref": "#/components/schemas/Notifications_ccb07798" }, "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Physical Port additional information" }, "order": { "$ref": "#/components/schemas/Order_9b002780" }, "operation": { "$ref": "#/components/schemas/Operation_21b488ab" }, "loas": { "type": "array", "items": { "properties": { "uuid": { "type": "string", "description": "uuid" }, "type": { "type": "string", "description": "Loa type", "example": "DIGITAL_LOA" } }, "description": "Port Loas" }, "description": "Port Loas" } }, "description": "Physical Port specification" }, "DataItem_5b5fb9cb": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/commands/1e9414f1-763e-4c0a-86c6-0bc8336048d9" }, "type": { "enum": [ "PING_COMMAND", "TRACEROUTE_COMMAND" ], "type": "string", "description": "Fabric Cloud Router Command Type", "example": "PING_COMMAND" }, "uuid": { "type": "string", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" }, "name": { "type": "string", "description": "Customer-provided Cloud Router name", "format": "string", "example": "test-fg-1" }, "description": { "type": "string", "example": "description" }, "state": { "enum": [ "PENDING", "SUCCEEDED", "FAILED", "DELETED" ], "type": "string", "description": "Fabric Cloud Router Command State", "example": "SUCCEEDED" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "request": { "$ref": "#/components/schemas/Request" }, "response": { "$ref": "#/components/schemas/Response_1421a8cf" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Get Fabric Cloud Router Command response object" }, "DataItem_66587e9f": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/name" }, "value": { "description": "new value for updated parameter" } }, "description": "Network change operation data" }, "DataItem_699ec854": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace" ], "type": "string" }, "path": { "type": "string", "description": "A JSON Pointer path." }, "value": { "type": "object", "description": "value to replace with" } }, "description": "Replace attribute value or sub-resource in the existing model" }, "DataItem_6bc185be": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "operation type applied to the resource" }, "path": { "enum": [ "/name", "/description", "/bandwidth", "/ipv4Subnet" ], "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter", "x-go-type": "json.RawMessage" } }, "description": "App Link change operation data" }, "DataItem_7e47f567": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/streams/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "TELEMETRY_STREAM" ], "type": "string", "description": "type" }, "name": { "type": "string", "description": "Customer-provided stream name" }, "description": { "type": "string", "description": "Customer-provided stream description" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_0246edb6" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "REPROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string", "description": "Stream provision state" }, "assetsCount": { "type": "integer", "description": "Stream assets count", "example": 1 }, "streamSubscriptionsCount": { "type": "integer", "description": "Stream subscriptions count", "example": 2 }, "alertRulesCount": { "type": "integer", "description": "Stream alert rules count", "example": 3 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Stream object" }, "DataItem_814550cc": { "type": "object", "properties": { "id": { "type": "integer", "description": "database ID", "format": "int64", "example": 420 }, "alertUid": { "type": "string", "description": "alert unique ID", "example": "PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM" }, "traceUid": { "type": "string", "description": "alert trace unique ID related to status change", "example": "1652686263561/PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM" }, "assetTagUid": { "type": "string", "description": "asset tag point unique id", "example": "PA8A.CB-CRITICAL-DB2:tripped" }, "assetTagDisplayName": { "type": "string", "description": "asset tag point display name", "example": "Tripped" }, "status": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string", "description": "alert status", "example": "INACTIVE" }, "value": { "$ref": "#/components/schemas/Value_ca751d15" }, "asset": { "$ref": "#/components/schemas/Asset_f8c64911" }, "configuration": { "$ref": "#/components/schemas/Configuration" }, "activeProcessing": { "$ref": "#/components/schemas/ActiveProcessing" }, "inactiveProcessing": { "$ref": "#/components/schemas/ActiveProcessing" } } }, "DataItem_8b0e3035": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 1 }, "type": { "enum": [ "APP_PROCESSOR" ], "type": "string", "description": "App Processor Type", "default": "APP_PROCESSOR", "example": "APP_PROCESSOR", "x-order": 2 }, "uuid": { "type": "string", "description": "App Processor UUID", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 3 }, "config": { "type": "string", "description": "Base64-encoded configuration for the processor attachment", "format": "byte", "example": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA...", "x-order": 4 }, "endpoint": { "type": "string", "description": "Endpoint DNS name assigned to the attached App Processor", "example": "123456.privateai.link", "x-order": 5 }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "App Link Attached App Processor object" }, "DataItem_8d896f90": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "DIRECT" ], "type": "string", "description": "Routing protocol type" }, "name": { "type": "string", "example": "My-direct-route-1" }, "directIpv4": { "type": "object", "properties": { "equinixIfaceIp": { "type": "string", "description": "Equinix side Interface IP address", "example": "192.168.100.0/30" } } }, "directIpv6": { "required": [ "equinixIfaceIp" ], "type": "object", "properties": { "equinixIfaceIp": { "type": "string", "description": "Equinix side Interface IP address", "example": "2001:db8:c59b::/1" } } } } }, "DataItem_98ae8af8": { "type": "object", "properties": { "href": { "type": "string", "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", "format": "uri" }, "type": { "enum": [ "XF_PORT" ], "type": "string", "description": "Type of Port" }, "uuid": { "type": "string", "description": "Equinix assigned response attribute for port identifier", "format": "uuid" }, "name": { "type": "string", "description": "Equinix assigned response attribute for Port name" }, "description": { "type": "string", "description": "Equinix assigned response attribute for Port description" }, "physicalPortsSpeed": { "minimum": 0.0, "type": "integer", "description": "Physical Ports Speed in Mbps" }, "connectionsCount": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Connection count" }, "physicalPortsType": { "enum": [ "1000BASE_LX", "10GBASE_LR", "100GBASE_LR4", "10GBASE_ER", "1000BASE_SX", "10GBASE_SMF", "400GBASE_LR4" ], "type": "string", "description": "Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports" }, "physicalPortsCount": { "type": "integer" }, "connectivitySourceType": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Port connectivity type" }, "bmmrType": { "enum": [ "SELF", "EQUINIX" ], "type": "string" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "state": { "enum": [ "PENDING", "PROVISIONING", "REPROVISIONING", "PENDING_CROSS_CONNECT", "PROVISIONED", "ACTIVE", "DEPROVISIONING", "DEPROVISIONED", "INACTIVE", "FAILED", "ADDED", "DELETED", "TO_BE_ADDED", "TO_BE_DELETED" ], "type": "string", "description": "Port lifecycle state" }, "order": { "$ref": "#/components/schemas/Order_9b002780" }, "operation": { "$ref": "#/components/schemas/Operation_2a3fcb9f" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "change": { "$ref": "#/components/schemas/Change_aad47080" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "serviceType": { "enum": [ "EPL", "MSP" ], "type": "string", "description": "Port service Type" }, "serviceCode": { "enum": [ "CX", "IX", "IA", "MC" ], "type": "string", "description": "Identifies the service type associated with this port" }, "bandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port bandwidth in Mbps" }, "availableBandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port available bandwidth in Mbps" }, "usedBandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port used bandwidth in Mbps" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "device": { "$ref": "#/components/schemas/Device_b2172721" }, "interface": { "type": "object", "properties": { "type": { "type": "string", "description": "Port interface type" } }, "description": "Port interface" }, "demarcationPointIbx": { "type": "string", "description": "A-side/Equinix ibx" }, "tetherIbx": { "type": "string", "description": "z-side/Equinix ibx" }, "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_970747e9" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_616e679f" }, "encapsulation": { "type": "object", "properties": { "type": { "enum": [ "DOT1Q", "QINQ", "UNTAGGED" ], "type": "string", "description": "Port encapsulation protocol type" }, "tagProtocolId": { "type": "string", "description": "Port encapsulation tag protocol identifier" } }, "description": "Port encapsulation configuration" }, "lagEnabled": { "type": "boolean", "description": "If LAG enabled" }, "lag": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "id" }, "enabled": { "type": "boolean", "description": "enabled" }, "name": { "type": "string", "description": "name" }, "memberStatus": { "type": "string", "description": "member status" } }, "description": "Port Lag" } ] }, "asn": { "type": "integer", "description": "Port ASN" }, "package": { "type": "object", "properties": { "code": { "enum": [ "STANDARD", "UNLIMITED", "UNLIMITED_PLUS" ], "type": "string", "description": "Type of Port Package" } }, "description": "Package settings for port" }, "settings": { "$ref": "#/components/schemas/Settings_10b6d98e" }, "physicalPortQuantity": { "type": "integer", "description": "Number of physical ports" }, "notifications": { "$ref": "#/components/schemas/Notifications_ccb07798" }, "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Port additional information" }, "physicalPorts": { "$ref": "#/components/schemas/PhysicalPorts" }, "loas": { "type": "array", "items": { "properties": { "uuid": { "type": "string", "description": "uuid" }, "type": { "type": "string", "description": "Loa type", "example": "DIGITAL_LOA" } }, "description": "Port Loas" }, "description": "Port Loas" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" } }, "description": "Port specification" }, "DataItem_9cb1450a": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "replace", "add", "remove" ], "type": "string", "description": "operation type applied to the resource" }, "path": { "enum": [ "/name" ], "type": "string", "description": "path inside document leading to updated parameter" }, "value": { "description": "new value for updated parameter", "x-go-type": "json.RawMessage" } }, "description": "App Processor change operation data" }, "DataItem_a2401f2a": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Profile" } ], "properties": { "state": { "enum": [ "ACTIVE", "PENDING_APPROVAL", "DELETED", "REJECTED" ], "type": "string", "description": "Equinix assigned state.", "example": "ACTIVE" }, "account": { "$ref": "#/components/schemas/Account_c1695b98" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "change": { "$ref": "#/components/schemas/Change_252edc53" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_94e8bdf1" } }, "description": "Service Profile is a software definition for a named provider service and it's network connectivity requirements.\nThis includes the basic marketing information and one\nor more sets of access points (a set per each access point type) fulfilling the provider service.\n" }, "DataItem_b4f5ed3f": { "required": [ "type", "uuid", "state" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_SUBSCRIPTION" ], "type": "string", "description": "App Subscription Type", "default": "APP_SUBSCRIPTION", "example": "APP_SUBSCRIPTION", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Subscription lifecycle state", "example": "PROVISIONING", "x-order": 6 }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" } }, "description": "App Subscription object attached to an App Service" }, "DataItem_ba551b86": { "required": [ "prefix" ], "type": "object", "properties": { "name": { "type": "string", "example": "Private-subnet-filter" }, "description": { "type": "string", "description": "Customer-provided Route Filter Rule description" }, "prefix": { "type": "string", "example": "192.168.0.0/24" }, "prefixMatch": { "type": "string", "default": "orlonger", "example": "orlonger, exact" } } }, "DataItem_be63b7fe": { "type": "object", "properties": { "specversion": { "type": "string", "description": "Cloud Event Open Telemetry specification" }, "source": { "type": "string", "description": "Cloud Event source" }, "id": { "type": "string", "description": "Cloud Event identifier", "format": "uuid" }, "type": { "type": "string", "description": "Equinix supported event type" }, "subject": { "type": "string", "description": "Cloud Event subject" }, "time": { "type": "string", "description": "Cloud Event time the event occurred", "format": "date-time" }, "dataschema": { "type": "string", "description": "Cloud Event dataschema reference" }, "datacontenttype": { "type": "string", "description": "Cloud Event data content type" }, "severitynumber": { "type": "string", "description": "Cloud Event severity number" }, "severitytext": { "type": "string", "description": "Cloud Event severity text" }, "equinixalert": { "type": "string", "description": "Equinix alert" }, "equinixorganization": { "type": "string", "description": "Equinix organization identifier" }, "equinixproject": { "type": "string", "description": "Equinix project identifier" }, "authtype": { "type": "string", "description": "Cloud Event auth type" }, "authid": { "type": "string", "description": "Cloud Event user identifier" }, "traceparent": { "type": "string", "description": "Cloud Event traceparent" }, "tracestate": { "type": "string", "description": "Cloud Event tracestate" }, "data": { "$ref": "#/components/schemas/Data_484c9827" } }, "description": "Cloud Event object" }, "DataItem_bfd4912a": { "type": "object", "properties": { "type": { "enum": [ "BGP", "DIRECT" ], "type": "string", "description": "Routing protocol type" } }, "anyOf": [ { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_ddceab00" }, { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_09093292" } ] }, "DataItem_c1a3ad9b": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the ACL template.", "example": "New template" }, "uuid": { "type": "string", "description": "The unique Id of the ACL template.", "example": "be7ef79e-31e7-4769-be5b-e192496f48aa" }, "description": { "type": "string", "description": "The description of the ACL template.", "example": "My description" }, "inboundRules": { "$ref": "#/components/schemas/InboundRules_8fddabb6" }, "createdBy": { "type": "string", "description": "Created by", "example": "nfvsit01" }, "createdDateTime": { "type": "string", "description": "Created date", "format": "date-time", "example": "2020-10-03T19:41:17Z" }, "status": { "enum": [ "PROVISIONED", "DEPROVISIONED", "DEVICE_NOT_READY", "FAILED", "NOT_APPLIED", "PROVISIONING" ], "type": "string", "description": "The status of the ACL template on the device.", "example": "DEVICE_NOT_READY" } } }, "DataItem_d6f7705f": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Handy shortcut for operation name", "example": "replace" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/name" }, "value": { "description": "new value for updated parameter" } } }, "DataItem_e5bc387e": { "required": [ "type", "changeLog" ], "type": "object", "properties": { "type": { "enum": [ "IPv4_BGP_ROUTE", "IPv4_STATIC_ROUTE", "IPv4_DIRECT_ROUTE", "IPv6_BGP_ROUTE", "IPv6_STATIC_ROUTE", "IPv6_DIRECT_ROUTE" ], "type": "string", "description": "Route table entry type", "example": "IPv4_BGP_SESSION" }, "protocolType": { "enum": [ "BGP", "STATIC", "DIRECT" ], "type": "string", "description": "Route table entry protocol type", "example": "BGP" }, "state": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string", "example": "ACTIVE" }, "prefix": { "type": "string", "example": "192.168.10.0/24" }, "nextHop": { "type": "string", "example": "10.10.10.5" }, "MED": { "type": "integer", "example": 5 }, "localPreference": { "type": "integer", "example": 200 }, "asPath": { "type": "array", "items": { "type": "string" } }, "connection": { "type": "object", "properties": { "uuid": { "type": "string", "example": "81331c52-04c0-4656-a4a7-18c52669348f" }, "name": { "type": "string", "example": "connection_1" }, "href": { "type": "string", "example": "https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Advertised and received route table entry object" }, "DataItem_ef249c5d": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Filter Rules URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER_RULE", "BGP_IPv6_PREFIX_FILTER_RULE" ], "type": "string", "description": "Route filter type" }, "uuid": { "type": "string", "description": "Route Filter Rule identifier", "format": "uuid", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" }, "name": { "type": "string", "example": "Private-subnet-filter-2" }, "description": { "type": "string", "description": "Customer-provided Route Filter Rule description" }, "state": { "enum": [ "PROVISIONING", "REPROVISIONING", "DEPROVISIONING", "PROVISIONED", "DEPROVISIONED", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Route filter rule status" }, "prefixMatch": { "type": "string", "description": "prefix matching operator", "default": "orlonger", "example": "exact" }, "change": { "$ref": "#/components/schemas/Change_979fb309" }, "action": { "enum": [ "PERMIT", "DENY" ], "type": "string" }, "prefix": { "type": "string", "example": "192.168.0.0/24" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } }, "DataItem_efe40161": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "BGP" ], "type": "string", "description": "Routing protocol type" }, "name": { "type": "string", "example": "My-BGP-route-1" }, "bgpIpv4": { "$ref": "#/components/schemas/BgpIpv4_c8b763be" }, "bgpIpv6": { "$ref": "#/components/schemas/BgpIpv6" }, "customerAsn": { "type": "integer", "description": "Customer asn", "format": "int64" }, "bgpAuthKey": { "type": "string", "description": "BGP authorization key" }, "asOverrideEnabled": { "type": "boolean", "description": "Enable AS number override" }, "bfd": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "interval": { "type": "string", "example": "100" } } } } }, "DataItem_f30043a6": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Aggregation Rules URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION_RULE" ], "type": "string", "description": "Route Aggregation type" }, "uuid": { "type": "string", "description": "Route Aggregation Rule identifier", "format": "uuid", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" }, "name": { "type": "string", "example": "Private-subnet-aggregation-2" }, "description": { "type": "string", "description": "Customer-provided Route Aggregation Rule description" }, "state": { "enum": [ "PROVISIONING", "REPROVISIONING", "DEPROVISIONING", "PROVISIONED", "DEPROVISIONED", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Route Aggregation Rule status" }, "change": { "$ref": "#/components/schemas/Change_47ab42a6" }, "prefix": { "type": "string", "example": "192.168.0.0/24" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } } }, "DataItem_f5fbfa16": { "required": [ "type", "uuid", "state", "changeLog" ], "type": "object", "properties": { "type": { "enum": [ "BGP_SESSION_STATUS_UPDATE", "ROUTE_TABLE_ENTRY_UPDATE", "RECEIVED_ROUTE_ENTRY_UPDATE", "ADVERTISED_ROUTE_ENTRY_UPDATE" ], "type": "string", "description": "Cloud router action type" }, "uuid": { "type": "string", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" }, "description": { "type": "string", "example": "description" }, "state": { "enum": [ "SUCCEEDED", "FAILED", "PENDING" ], "type": "string", "description": "Cloud router action state" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "href": { "type": "string", "example": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9" }, "connection": { "$ref": "#/components/schemas/Connection_aa288f10" }, "router": { "$ref": "#/components/schemas/Router_2239ca95" } }, "description": "Cloud router actions response object" }, "Data_00e43f43": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_1406f4be" } }, "Data_08f4c8d1": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_be63b7fe" }, "description": "Data returned from the API call." }, "Data_09050040": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceToken" }, "description": "List of Service Tokens" }, "Data_10fce732": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_150a893e" } }, "Data_17ed86c9": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_b4f5ed3f" }, "description": "Data returned from the API call." }, "Data_1efc0515": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_814550cc" }, "description": "Array of the alerts." }, "Data_2d124c60": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_07afdb02" } }, "Data_30d132ad": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "add", "replace", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/" }, "value": { "$ref": "#/components/schemas/DataItem_062179d0" } }, "description": "Routing Protocol change operation data" }, "Data_3f870086": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_8b0e3035" }, "description": "Data returned from the API call." }, "Data_4194e588": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_1a4953ef" }, "description": "Data returned from the API call." }, "Data_42431b35": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_f5fbfa16" }, "description": "Data returned from the API call." }, "Data_484c9827": { "type": "object", "properties": { "message": { "type": "string", "description": "Cloud Event message" }, "resource": { "$ref": "#/components/schemas/Resource_5c92ca19" }, "auth": { "$ref": "#/components/schemas/Auth" } } }, "Data_4bf85d8a": { "required": [ "errors" ], "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/Errors_d248cda4" } } }, "Data_4d64e2a4": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_d6f7705f" }, "default": [] }, "Data_4dca6a2b": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_0e6dd2e7" } }, "Data_56f36f80": { "allOf": [ { "required": [ "request", "service" ], "type": "object", "properties": { "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } }, "request": { "type": "string" } } }, { "$ref": "#/components/schemas/Data_4bf85d8a" } ] }, "Data_5c274b7f": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_e5bc387e" }, "description": "Data returned from the API call." }, "Data_66916414": { "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_27ae5d2c" }, "expirationDateTime": { "type": "string", "description": "Date and time when this LOA expires.
Default to 3 months from the creation date\n", "format": "date-time", "example": "2026-11-06T07:00:00Z" }, "portalUrl": { "type": "string", "description": "Portal URL for the LOA to either accept from requestor
or authorize from the issuer.\n", "example": "https://portal.equinix.com/fabric/loa/inventory/issuer/29cc7878-54e3-4e1a-8651-87a61354bac2/authorize" } }, "description": "Action Data.
For LOA_ISSUER_AUTHORIZATION — always required.\n" }, "Data_8223e945": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Handy shortcut for operation name", "example": "replace" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/name" }, "value": { "description": "new value for updated parameter" } }, "description": "Port change operation data" }, "Data_86460fc5": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_01b53787" } }, "Data_88a1364d": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_bfd4912a" }, "description": "List of Routing Protocols" }, "Data_916fd1b7": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_6bc185be" } }, "Data_92d21180": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "add", "replace", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/" }, "value": { "required": [ "prefix" ], "type": "object", "properties": { "name": { "type": "string", "example": "Private-subnet-Aggregation" }, "description": { "type": "string", "description": "Customer-provided Route Aggregation Rule description" }, "prefix": { "type": "string", "example": "192.168.0.0/24" } } } }, "description": "Route Aggregation Rule change operation data" }, "Data_9dab13b8": { "type": "array", "items": { "$ref": "#/components/schemas/TagsItem_c5fc2f6e" } }, "Data_a5b341f0": { "type": "object", "properties": { "notes": { "$ref": "#/components/schemas/Notes" }, "attachments": { "$ref": "#/components/schemas/Attachments_18af2a37" }, "schedule": { "$ref": "#/components/schemas/Schedule_8b5845ab" }, "liveTrafficConsentProvided": { "type": "boolean", "description": "Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic.\n", "example": true }, "services": { "$ref": "#/components/schemas/Services_0030155b" }, "notifications": { "$ref": "#/components/schemas/Notifications_7885f438" }, "order": { "$ref": "#/components/schemas/Order_cee822fd" } }, "description": "Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule, services, liveTrafficConsentProvided, notifications and order are applicable for XC_DEINSTALL.
Each schedule, service, note and attachment carries the href and the uuid of the sub-resource it refers to.
Not applicable to the other action types.\n" }, "Data_aa931f6a": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_a2401f2a" } }, "Data_adafd426": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "add", "replace", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/" }, "value": { "$ref": "#/components/schemas/DataItem_ba551b86" } }, "description": "Route filter rule change operation data" }, "Data_adf00330": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_66587e9f" } }, "Data_c55f2d51": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "type": "string", "description": "Handy shortcut for operation name", "example": "add" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/ipv6" }, "value": { "description": "new value for updated parameter" } }, "description": "Connection change operation data" }, "Data_cc295fc2": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_22ddc33e" }, "description": "Data returned from the API call." }, "Data_cef11c0f": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_9cb1450a" } }, "Data_d67405e5": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "add", "replace", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/" }, "value": { "$ref": "#/components/schemas/Value_56ee99c6" } }, "description": "Route filter change operation data" }, "Data_da9164b4": { "type": "object", "properties": { "zSide": { "$ref": "#/components/schemas/ASide_cdc3f780" }, "providerBandwidth": { "type": "integer", "description": "Authorization key bandwidth in Mbps" }, "operation": { "$ref": "#/components/schemas/Operation_e2c43536" } }, "description": "Connection acceptance data" }, "Data_db213e6e": { "allOf": [ { "required": [ "request", "service" ], "type": "object", "properties": { "service": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" } } }, "request": { "type": "string" } } }, { "required": [ "rejectionReason" ], "type": "object", "properties": { "rejectionReason": { "type": "string" } } } ] }, "Data_e2b21d81": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_7e47f567" }, "description": "Data returned from the API call." }, "Data_e5b43534": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_034e7d0f" } }, "Data_f02cb8b3": { "required": [ "op", "path", "value" ], "type": "object", "properties": { "op": { "enum": [ "add", "replace", "remove" ], "type": "string", "description": "Handy shortcut for operation name" }, "path": { "type": "string", "description": "path inside document leading to updated parameter", "example": "/" }, "value": { "$ref": "#/components/schemas/Value_568ccaf0" } }, "description": "Route Aggregation change operation data" }, "Data_f0a6c239": { "allOf": [ { "$ref": "#/components/schemas/Data_a5b341f0" } ] }, "Data_f46a25cc": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_f30043a6" }, "description": "List of Route Aggregation Rules" }, "Data_f8576704": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_98ae8af8" }, "description": "GET All User Port Across Fabric Metros" }, "Data_fbbbdffe": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_ef249c5d" }, "description": "List of Route Filter Rules" }, "Datapoints": { "type": "array", "items": { "type": "object", "properties": { "endDateTime": { "type": "string", "description": "Datapoint end date and time", "format": "date-time" }, "startDateTime": { "type": "string", "description": "Datapoint start date and time", "format": "date-time" }, "value": { "type": "number", "description": "Datapoint value" } } }, "description": "Metric data points" }, "Day0TextFileId": { "type": "string", "description": "Some devices require a day0TextFileId. Upload your license file by calling Upload File API. You'll get a fileUuid in the response. You can enter the value in the day0TextFileId field of the create payload to create a virtual device. Check the payloads of individual devices (provided as Postman Scripts on our API doc site) for details.", "example": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b" }, "DeliveryDate": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit for this range is DAYS.", "example": "USD" }, "min": { "type": "integer", "description": "Minimum value for the range.", "example": 1 }, "max": { "type": "integer", "description": "Maximum value for the range.", "example": 10 } }, "description": "Range details for delivery window." }, "DemarcationPoint_04efc84a": { "type": "object", "properties": { "patchPanelId": { "type": "string", "description": "Unique identifier of the patch panel.", "example": "CP:Demarc:1259684" }, "patchPanelPortA": { "type": "string", "description": "Specify the desired port number for Port A.
When ports are not provided, next available ports will be used.\n", "example": "10" }, "patchPanelPortB": { "type": "string", "description": "Specify the desired port number for Port B.
When ports are not provided, next available ports will be used.
Required for Connector type FC, SC and ST only.\n", "example": "11" }, "connectorType": { "enum": [ "FC", "SC", "LC", "ST" ], "type": "string", "description": "Type of Connector", "example": "SC" } }, "description": "Specifies the demarcation point: the patch panel and ports at this side.\n" }, "DemarcationPoint_27ae5d2c": { "type": "object", "properties": { "cageUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cage.", "example": "SV1:00:000000" }, "cabinetUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cabinet.", "example": "SV1:00:000000:0105" }, "patchPanelId": { "type": "string", "description": "Unique identifier of the Patch Panel.\n", "example": "CP:Demarc:1259684" }, "patchPanelPortA": { "type": "integer", "description": "Specify the desired port number.
When ports are not provided, next available ports will be used.\n", "example": 23 }, "patchPanelPortB": { "type": "integer", "description": "Specify the desired port number.
When ports are not provided, next available ports will be used.
Required for Connector type FC and ST only.\n", "example": 24 }, "connectorType": { "enum": [ "FC", "SC", "LC", "ST" ], "type": "string", "description": "Connector Type", "example": "SC" } }, "description": "Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB \n and connectorType is required.\n" }, "DemarcationPoint_48e2f663": { "allOf": [ { "$ref": "#/components/schemas/DemarcationPoint_91e26ca6" }, { "required": [ "patchPanelId", "connectorType" ] } ] }, "DemarcationPoint_91e26ca6": { "type": "object", "properties": { "patchPanelId": { "type": "string", "description": "Patch Panel Identifier.", "example": "CP:Demarc:1259684" }, "patchPanelPortA": { "type": "integer", "description": "Specify the desired port number. When ports are not provided, next available ports will be used.\n", "example": 35 }, "patchPanelPortB": { "type": "integer", "description": "Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.\n", "example": 32 }, "connectorType": { "type": "string", "description": "Connector Type.", "example": "SC" } }, "description": "Cross Connect Demarcation Point - patch panel and port details." }, "DemarcationPoint_970747e9": { "type": "object", "properties": { "cabinetUniqueSpaceId": { "type": "string", "description": "Port cabinet unique space id" }, "cageUniqueSpaceId": { "type": "string", "description": "Port cage unique space id" }, "patchPanel": { "type": "string", "description": "Port patch panel" }, "patchPanelName": { "type": "string", "description": "Port patch panel" }, "patchPanelPortA": { "type": "string", "description": "Port patch panel port A" }, "patchPanelPortB": { "type": "string", "description": "Port patch panel port B" }, "connectorType": { "type": "string", "description": "Port connector type" }, "ibx": { "type": "string", "description": "Port ibx identifier" } }, "description": "Customer physical Port" }, "DemarcationPoint_a5cf3909": { "allOf": [ { "$ref": "#/components/schemas/DemarcationPoint_91e26ca6" }, { "type": "object", "properties": { "cageUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cage.", "example": "SV1:00:000000" }, "cabinetUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cabinet.", "example": "SV1:00:000000:0100" } } } ], "description": "A-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the A-Side space.\n" }, "DemarcationPoint_a8552e97": { "allOf": [ { "$ref": "#/components/schemas/DemarcationPoint_aae0734d" } ], "description": "Required for a patch panel to patch panel Cross Connect." }, "DemarcationPoint_a96011a1": { "allOf": [ { "$ref": "#/components/schemas/DemarcationPoint_91e26ca6" }, { "type": "object", "properties": { "cageUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cage.", "example": "SV2:00:000000" }, "cabinetUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cabinet.", "example": "SV2:00:000000:0100" } } } ], "description": "Z-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the Z-Side space.\n" }, "DemarcationPoint_aae0734d": { "allOf": [ { "$ref": "#/components/schemas/DemarcationPoint_91e26ca6" }, { "type": "object", "properties": { "cageUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cage.", "example": "SV2:00:000000" }, "cabinetUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cabinet.", "example": "SV2:00:000000:0100" } } } ], "description": "Z-Side demarcation point.
Specify the destination patch panel and ports.
Specify cageUniqueSpaceId and cabinetUniqueSpaceId to identify the destination space.\n" }, "DemarcationPoint_d8b2b563": { "allOf": [ { "$ref": "#/components/schemas/DemarcationPoint_04efc84a" }, { "type": "object", "properties": { "cageUniqueSpaceId": { "type": "string", "description": "Unique identifier of the cage.", "example": "SV1:01:002174" }, "cabinetUniqueSpaceId": { "type": "string", "description": "Unique identifier of the cabinet.", "example": "Demarc" } } } ], "description": "Demarcation point as provisioned, with the cage and cabinet it belongs to.\n" }, "DetailsItem_5719f1a6": { "required": [ "type", "value" ], "type": "object", "properties": { "type": { "enum": [ "PHONE", "MOBILE", "EMAIL" ], "type": "string", "description": "Contact information such as email, phone and mobile number. Note that email is always required.", "example": "PHONE" }, "value": { "type": "string", "description": "Value of related `type`. Use email addresss when type of `EMAIL`. Use phone number and prefix with country (i.e. +1 for US) for `PHONE` and `MOBILE` type.", "example": "+1-4601231122" } }, "description": "Contact details." }, "DetailsItem_a0f54f26": { "required": [ "type", "value" ], "type": "object", "properties": { "notes": { "type": "string", "description": "Additional note applicable to the given contact option.", "example": "Do not call me after 6 P.M. CEST" }, "value": { "type": "string", "description": "Value specific to the given contact type.", "example": "kyle@mail.com" }, "type": { "enum": [ "EMAIL", "PHONE", "MOBILE", "SECONDARY_EMAIL" ], "type": "string", "description": "Means of contact.", "example": "EMAIL" } }, "description": "Contact details" }, "Details_2c8a9e35": { "type": "object", "properties": { "invoiceId": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Invoice number / Identifier" }, "paymentId": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Payment number / Identifier" } }, "description": "Provide Billing Tickets product specific details to support faster trouble resolution." }, "Details_40773425": { "allOf": [ { "$ref": "#/components/schemas/Details_5cc2b179" } ] }, "Details_435efc1e": { "required": [ "schedule1", "schedule2", "schedule3", "timezone", "assetId", "orderId", "product", "testingOnSite", "isUrgentRequest" ], "type": "object", "properties": { "schedule1": { "type": "string", "description": "Preferred availability (Option 1).", "example": "15/Dec/2023 Start Time: 16:00 End Time:16:45" }, "schedule2": { "type": "string", "description": "Preferred availability (Option 2).", "example": "29/Dec/2023 Start Time: 16:45 End Time:19:00" }, "schedule3": { "type": "string", "description": "Preferred availability (Option 3).", "example": "11/Jan/2024 Start Time: 17:00 End Time:23:15" }, "timezone": { "type": "string", "description": "Preferred availability time zone.", "example": "Etc/GMT+12" }, "assetId": { "type": "string", "description": "Asset number.", "example": "4-231092048941" }, "orderId": { "type": "string", "description": "Order number.", "example": "1-231086879647" }, "product": { "enum": [ "Equinix Fabric Port", "Equinix Internet Access", "Internet Exchange Port" ], "type": "string", "description": "Product.", "example": "Equinix Internet Access" }, "testingOnSite": { "enum": [ "Yes", "No" ], "type": "string", "description": "Will someone from your team be on-site during the testing?", "example": "No" }, "isUrgentRequest": { "enum": [ "Yes", "No" ], "type": "string", "description": "Is your request urgent?", "example": "Yes" }, "businessJustification": { "enum": [ "Delayed Product Onboarding", "Call rescheduled due to an error/issue", "End-User Service Impacting", "Other" ], "type": "string", "description": "Reason for urgent request.", "example": "Delayed Product Onboarding" }, "otherBusinessJustification": { "type": "string", "description": "Other reason than the provided three for urgent request.", "example": "Other business justification." } } }, "Details_5cc2b179": { "type": "object", "properties": { "callFromCage": { "type": "boolean", "description": "Requirement for the IBX technician to call the technical contact from the cage. If true, IBX technician will call the technical contact from the cage.", "default": false }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Availability type if call from cage is set as true.", "default": "ANYTIME" }, "timezone": { "$ref": "#/components/schemas/Timezone_83d81d7f" }, "submarineEngineerRequired": { "type": "boolean", "description": "Requirement for submarine cable station engineering support.", "default": false } }, "description": "Details or requirements to support ticket resolution, depending on the trouble category you are facing." }, "Details_7211ffcd": { "maxItems": 3, "minItems": 2, "type": "array", "items": { "$ref": "#/components/schemas/DetailsItem_5719f1a6" }, "description": "Reference of the related party, could be a party reference or a party role reference" }, "Details_82399dd0": { "type": "array", "items": { "properties": { "type": { "enum": [ "EMAIL", "PHONE", "MOBILE", "SECONDARY_EMAIL" ], "type": "string", "example": "EMAIL" }, "value": { "type": "string", "example": "john.doe@nowhere.com" }, "notes": { "type": "string", "description": "Contact additional info\n", "example": "org internal communication only" } } } }, "Details_cea2fa4b": { "anyOf": [ { "$ref": "#/components/schemas/Details_40773425" }, { "$ref": "#/components/schemas/Details_40773425" }, { "$ref": "#/components/schemas/Details_40773425" }, { "$ref": "#/components/schemas/Details_40773425" }, { "$ref": "#/components/schemas/Details_40773425" }, { "$ref": "#/components/schemas/Details_40773425" }, { "$ref": "#/components/schemas/Details_40773425" }, { "$ref": "#/components/schemas/Details_40773425" }, { "type": "object", "properties": { "purchaseOrderNumber": { "maxLength": 100, "minLength": 5, "type": "string", "description": "Purchase order number" } }, "description": "Provide SmartKey Tickets product specific details to support faster trouble resolution." }, { "$ref": "#/components/schemas/Details_2c8a9e35" }, { "$ref": "#/components/schemas/Details_40773425" } ], "description": "List of additional details or requirements to support ticket resolution, depending on the trouble category you are facing." }, "Details_e41b369e": { "type": "object", "properties": { "carrierName": { "maxLength": 50, "minLength": 2, "type": "string", "description": "This field should be used to specify carrier name when `carrier` is of `OTHER`", "example": "carrier_name" }, "numberOfBoxes": { "maximum": 100000.0, "type": "number", "description": "Number of boxes to be received.", "example": 10 } } }, "Details_ed303304": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/DetailsItem_a0f54f26" }, "description": "Means of contact." }, "DetectionMethod_3af096e5": { "type": "object", "properties": { "type": { "enum": [ "THRESHOLD", "OUTLIER" ], "type": "string", "description": "* THRESHOLD - Alert when a metric crosses a defined threshold by user.\n* OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.\n" }, "windowSize": { "type": "string", "description": "Stream alert rule metric window size", "example": "PT15M" }, "operand": { "enum": [ "ABOVE", "BELOW" ], "type": "string", "description": "Stream alert rule metric operand" }, "warningThreshold": { "type": "string", "description": "Stream alert rule metric warning threshold" }, "criticalThreshold": { "type": "string", "description": "Stream alert rule metric critical threshold" } } }, "DetectionMethod_5a5caddf": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "THRESHOLD", "OUTLIER" ], "type": "string", "description": "* THRESHOLD - Alert when a metric crosses a defined threshold by user.\n* OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.\n" }, "windowSize": { "type": "string", "description": "Stream alert rule metric window size", "example": "PT15M" }, "operand": { "enum": [ "ABOVE", "BELOW" ], "type": "string", "description": "Stream alert rule metric operand" }, "warningThreshold": { "type": "string", "description": "Stream alert rule metric warning threshold" }, "criticalThreshold": { "type": "string", "description": "Stream alert rule metric critical threshold" } } }, "DeviceTypeCode": { "enum": [ "C8000V", "C8000V-SDWAN", "PA-VM", "ASAV", "CGUARD", "FG-VM", "MERAKI-VMX", "PRISMA-SDWAN", "INFOBLOX", "AVIATRIX_EDGE", "VSRX", "ARISTA-ROUTER", "EDGECONNECT-SDWAN", "VERSA_SDWAN", "NGINX", "BLUECAT", "VYOS-ROUTER", "FG-SDWAN", "BLUECAT-EDGE-SERVICE-POINT", "F5XC", "6WIND-VSR", "VSRX-SDWAN", "FORTIGATE_VM" ], "type": "string", "description": "Device type code (e.g., C8000V)", "example": "C8000V" }, "Device_0c0510f1": { "title": "Device", "required": [ "name", "slot", "port" ], "type": "object", "properties": { "name": { "maxLength": 200, "type": "string", "description": "Device name", "example": "Device Name" }, "slot": { "maxLength": 50, "type": "string", "description": "Device slot", "example": "50" }, "port": { "maxLength": 50, "type": "string", "description": "Device port", "example": "50" } } }, "Device_50154345": { "allOf": [ { "$ref": "#/components/schemas/Device_62654b37" } ], "description": "Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service." }, "Device_62654b37": { "type": "object", "properties": { "cabinetUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cabinet.", "example": "SV2:00:000000:0100" }, "port": { "type": "integer", "description": "Port number.", "example": 32 }, "connectorType": { "type": "string", "description": "Connector Type.", "example": "SC" } }, "description": "Patch equipment installed for the Cross Connect." }, "Device_7a80d855": { "required": [ "cabinetUniqueSpaceId", "port", "connectorType" ], "type": "object", "properties": { "cabinetUniqueSpaceId": { "type": "string", "description": "Unique identifier of the Cabinet.", "example": "SV2:00:000000:0100" }, "port": { "type": "integer", "description": "Port number.", "example": 32 }, "connectorType": { "type": "string", "description": "Connector Type.", "example": "SC" } }, "description": "Patch equipment installed for the Cross Connect." }, "Device_b2172721": { "type": "object", "properties": { "name": { "type": "string", "description": "Device name" }, "redundancy": { "type": "object", "properties": { "group": { "type": "string", "description": "Device redundancy group" }, "priority": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Device redundancy priority" } }, "description": "Device redundancy" }, "vcBandwidthMax": { "type": "integer", "description": "Maximum bandwidth allowed for connection.", "format": "int64" } }, "description": "Port device" }, "Device_da0f16aa": { "allOf": [ { "$ref": "#/components/schemas/Device_7a80d855" } ], "description": "Patch equipment device details. Required for the XC_PATCH_EQUIPMENT service.\n" }, "Diloa_findByUuidResult": { "type": "object", "properties": { "token": { "type": "string", "description": "User-friendly Digital LOA document identifier.", "example": "REDF-4R56" }, "uuid": { "type": "string", "description": "Digital LOA document identifier.", "format": "uuid", "example": "079dc798-05e8-11ed-b939-0242ac120002" }, "state": { "enum": [ "READY_FOR_USE", "LOCKED", "USED", "CANCELLED", "EXPIRED", "PENDING_REQUESTOR_ACCEPTANCE", "PENDING_PROVIDER_AUTHORIZATION" ], "type": "string", "description": "Digital LOA document status.", "example": "USED" }, "products": { "$ref": "#/components/schemas/Products" }, "requestor": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NEW_RELATIONSHIP", "CUSTOMER_ORGANIZATION" ], "type": "string", "description": "Party type", "example": "CUSTOMER_ORGANIZATION" } }, "description": "Party interface for Customer Organization" }, "provider": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "NEW_RELATIONSHIP", "CUSTOMER_ORGANIZATION" ], "type": "string", "description": "Party type", "example": "CUSTOMER_ORGANIZATION" } }, "description": "Party interface for Customer Organization" }, "changeLog": { "type": "object", "properties": { "createdDateTime": { "type": "string", "description": "Date and time of Digital LOA document creation.", "format": "date-time", "example": "2022-11-17T22:59:59.999000Z" } }, "description": "Change interface" }, "links": { "$ref": "#/components/schemas/Links_459c701e" }, "notes": { "type": "string", "description": "Additional information to be considered.", "example": "Please contact me" }, "expiryDateTime": { "type": "string", "description": "Digital LOA document expiration date.", "format": "date-time", "example": "2022-11-17T22:59:59.999000Z" }, "href": { "type": "string", "description": "Digital LOA document URI.", "example": "diloa/v1/digitalLoas/402cbf99-97d7-440f-8291-1a4b9639154a" } }, "description": "Digital Letter of Authorization", "x-fastmcp-top-level-schema": "Loa" }, "Documents": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDocument" }, "description": "Array of invoice documents" }, "DownloadableReport": { "title": "DownloadableReport", "required": [ "reportId", "status" ], "type": "object", "properties": { "reportId": { "type": "string", "description": "A unique UUID string denoting the id of the report entry", "format": "uuid" }, "scheduledId": { "type": "string", "description": "Scheduled Id for the report entry", "format": "uuid" }, "reportName": { "minLength": 1, "type": "string", "description": "Name of the report" }, "fileName": { "minLength": 1, "type": "string", "description": "File name of the report" }, "fileType": { "minLength": 1, "enum": [ "XLS", "CSV", "PDF" ], "type": "string", "description": "File type of the report" }, "fileSize": { "minimum": 0.0, "type": "number", "description": "Size of the report in bytes" }, "createdFor": { "type": "string", "description": "Person/Entity whom this entry belongs to" }, "requestedDate": { "type": "string", "description": "Time when this entry was first requested", "format": "date-time" }, "generatedDate": { "type": "string", "description": "Time when this entry was generated", "format": "date-time" }, "status": { "title": "ReportStatus", "enum": [ "IN_PROGRESS", "DELAYED", "SUCCESS", "ERROR", "INACTIVE" ], "type": "string", "description": "Status of the report" }, "numberOfDownloads": { "minimum": 0.0, "type": "integer", "description": "Number of times this report is downloaded by the customer", "default": 0 } }, "example": { "reportId": "8f204c59-f70f-437b-92d5-dbbde2932de5", "scheduledId": "886fc5de-6304-46c7-902c-d946c656c169", "reportName": "Duis", "fileName": "velit Duis sit", "fileType": "XLS", "fileSize": 95806395, "createdBy": "sint", "requestedDate": "2807-08-28T13:34:33.735Z", "generatedDate": "2847-09-19T23:25:35.305Z", "status": "SUCCESS", "numberOfDownloads": 1 } }, "Emails": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationEmail" }, "description": "Event/Notification Email Content" }, "Environmental": { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentalItem" }, "description": "List of environmental message type to subscribe" }, "EnvironmentalItem": { "required": [ "accountNumber", "ibx" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "135888" }, "ibx": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "level": { "$ref": "#/components/schemas/Level" } }, "description": "Environmental messages provide the latest temperature and humidity readings at the IBX and zone levels." }, "Environments": { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentsItem" }, "description": "Provider environments associated with this IC_PROFILE service profile. Beta" }, "EnvironmentsItem": { "type": "object", "properties": { "href": { "type": "string", "description": "Provider Environment URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned provider environment identifier", "format": "uuid" }, "type": { "enum": [ "IC_ENV" ], "type": "string", "description": "Provider environment type" }, "name": { "type": "string", "description": "Provider environment name", "example": "US West 1 – Production" }, "description": { "type": "string", "description": "Provider environment description", "example": "Primary production environment" }, "sellerRegion": { "type": "string", "description": "Cloud provider region identifier", "example": "us-west-1" }, "supportedBandwidths": { "type": "array", "items": { "type": "integer" }, "description": "Supported bandwidths in Mbps", "example": [ 1000, 10000, 100000 ] }, "metros": { "$ref": "#/components/schemas/Metros" }, "supportedFeatures": { "type": "array", "items": { "type": "string" }, "description": "Supported Feature Types", "example": [ "FEATURE_TYPE_L3_BASE" ] }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Provider Environment associated with an IC_PROFILE service profile Beta" }, "EquinixPeerIps": { "type": "array", "items": { "$ref": "#/components/schemas/EquinixPeerIpsItem" } }, "EquinixPeerIpsItem": { "pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$", "type": "string" }, "EquinixStatus": { "enum": [ "REJECTED_ACK", "REJECTED", "PENDING_DELETE", "PROVISIONED", "PENDING_APPROVAL", "NOT_PROVISIONED", "DEPROVISIONING", "NOT_DEPROVISIONED", "PENDING_AUTO_APPROVAL", "PROVISIONING", "PENDING_BGP_PEERING", "PENDING_PROVIDER_VLAN", "DEPROVISIONED", "DELETED", "AUTO_APPROVAL_FAILED", "PENDING_PROVIDER_VLAN_ERROR", "DRAFT", "CANCELLED", "PENDING_INTERFACE_CONFIGURATION" ], "type": "string", "description": "Connection status" }, "ErrorsItem_30fce0ec": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Equinix Observability error code" }, "errorMessage": { "type": "string", "description": "Equinix Observability error message" }, "dateTime": { "type": "string", "description": "Equinix Observability error date time", "format": "date-time" }, "additionalInfo": { "$ref": "#/components/schemas/AdditionalInfo_db75691e" } }, "description": "Error information for stream subscription delivery" }, "ErrorsItem_425b1fcf": { "required": [ "errorCode", "errorMessage" ], "type": "object", "properties": { "errorCode": { "pattern": "^EQ-\\d{7}$", "type": "string" }, "errorMessage": { "type": "string" }, "correlationId": { "type": "string" }, "details": { "type": "string" }, "help": { "type": "string" }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "reason": { "type": "string" } } } } }, "description": "Error Response with details" }, "ErrorsItem_efa64865": { "required": [ "errorCode", "errorMessage" ], "type": "object", "properties": { "errorCode": { "pattern": "^EQ-\\d{7}$", "type": "string", "description": "Error code\n", "example": "EQ-7100100" }, "errorMessage": { "type": "string", "description": "Error message", "example": "Unknown error occurred in Internet Access\n" }, "correlationId": { "type": "string", "description": "Correlation ID identifying the request\n", "example": "4e7b5042-b553-4d5e-a2ac-c73bf6d4ee27" }, "details": { "type": "string", "description": "Error details\n", "example": "Unknown error occurred in Internet Access\n" }, "help": { "type": "string", "description": "Link to the help information\n", "format": "uri", "example": "https://developer.equinix.com/faq" }, "additionalInfo": { "$ref": "#/components/schemas/AdditionalInfo_17816e41" } }, "description": "Error Response with details" }, "Errors_20cb1774": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorsItem_30fce0ec" }, "description": "List of error information for stream subscription delivery" }, "Errors_81abeebb": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorsItem_425b1fcf" }, "description": "List of errors" }, "Errors_a7ba79b3": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorsItem_425b1fcf" } }, "Errors_d248cda4": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorsItem_efa64865" }, "description": "List of Error Message" }, "ExchangeServiceAndExpression": { "required": [ "and" ], "type": "object", "properties": { "and": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangeServiceSearchExpression" } } } }, "ExchangeServiceOrExpression": { "required": [ "or" ], "type": "object", "properties": { "or": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangeServiceSearchExpression" } } } }, "ExchangeServicePropertyExpression": { "required": [ "property", "operator", "values" ], "type": "object", "properties": { "property": { "enum": [ "/project/projectId", "/uuid", "/state", "/name", "/bandwidth", "/changelog/createdDateTime", "/changelog/updatedDateTime", "/changelog/deletedDateTime", "/location/metroCode" ], "type": "string", "description": "Possible field names to use on filters" }, "operator": { "enum": [ "=", "!=", "BETWEEN", "<", "<=", ">", ">=", "LIKE", "ILIKE", "IN" ], "type": "string" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "ExchangeServiceSearchExpression": { "anyOf": [ { "$ref": "#/components/schemas/ExchangeServiceAndExpression" }, { "$ref": "#/components/schemas/ExchangeServiceOrExpression" }, { "$ref": "#/components/schemas/ExchangeServicePropertyExpression" } ] }, "ExchangeServiceSearchSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/name", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } }, "Expression": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/Expressions" }, "or": { "$ref": "#/components/schemas/Expressions" }, "property": { "$ref": "#/components/schemas/SearchFieldName" }, "operator": { "enum": [ "=", "!=", ">", ">=", "<", "<=", "LIKE", "ILKE", "IS NOT NULL", "IS NULL", "IN", "BETWEEN" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "Expressions": { "type": "array", "items": { "$ref": "#/components/schemas/Expression" } }, "FabricConnectionAccessPoint": { "title": "fabricConnectionAccessPoint", "type": "object", "properties": { "accessPoint": { "$ref": "#/components/schemas/AccessPoint_22dada48" } }, "description": "Fabric Connection access point object." }, "FabricConnectionResponse": { "title": "fabricConnectionResponse", "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "uri" }, "type": { "type": "string", "description": "Connection Type." }, "uuid": { "type": "string", "description": "Connection UUID.", "format": "uuid" }, "aSide": { "$ref": "#/components/schemas/FabricConnectionAccessPoint" }, "zSide": { "$ref": "#/components/schemas/FabricConnectionAccessPoint" } }, "description": "Fabric Connection Precision Time Service Response Object" }, "FabricConnectionUuid": { "title": "fabricConnectionUuid", "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "uri" }, "type": { "type": "string", "description": "Connection Type" }, "uuid": { "type": "string", "description": "Connection UUID.", "format": "uuid" } }, "description": "UUID of the Fabric Connection Instance", "example": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f" } }, "Fabric_attachAppDomainToAppLinkResult": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_DOMAIN" ], "type": "string", "description": "App Domain Type", "default": "APP_DOMAIN", "example": "APP_DOMAIN", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Domain name", "example": "atlassian.net", "x-order": 4 }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "App Link Attached App Domain object", "x-fastmcp-top-level-schema": "AppLinkAppDomainAttachment" }, "Fabric_attachAppProcessorToAppLinkResult": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 1 }, "type": { "enum": [ "APP_PROCESSOR" ], "type": "string", "description": "App Processor Type", "default": "APP_PROCESSOR", "example": "APP_PROCESSOR", "x-order": 2 }, "uuid": { "type": "string", "description": "App Processor UUID", "format": "uuid", "example": "90ee425c-9988-454c-96d9-1128bc16350f", "x-order": 3 }, "config": { "type": "string", "description": "Base64-encoded configuration for the processor attachment", "format": "byte", "example": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA...", "x-order": 4 }, "endpoint": { "type": "string", "description": "Endpoint DNS name assigned to the attached App Processor", "example": "123456.privateai.link", "x-order": 5 }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "App Link Attached App Processor object", "x-fastmcp-top-level-schema": "AppLinkAppProcessorAttachment" }, "Fabric_attachAppServiceToAppLinkResult": { "required": [ "uuid", "geoScope", "destinationIp" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 1 }, "type": { "enum": [ "APP_SERVICE" ], "type": "string", "description": "App Service Type", "default": "APP_SERVICE", "example": "APP_SERVICE", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 3 }, "geoScope": { "type": "string", "description": "Geo scope for the App Service", "example": "GLOBAL", "x-order": 4 }, "destinationIp": { "type": "string", "description": "Target IP for forwarding API requests", "format": "ipv4", "example": "10.10.1.110", "x-order": 5 }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHING_FAILED", "ATTACHED", "DETACHING", "DETACHING_FAILED", "DETACHED", "REATTACHING", "REATTACHING_FAILED" ], "type": "string", "description": "App Link attachment lifecycle state", "format": "string", "example": "ATTACHED", "x-order": 10 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_e362f715" } }, "description": "App Link Attached App Service object", "x-fastmcp-top-level-schema": "AppLinkAppServiceAttachment" }, "Fabric_attachConnectionRouteAggregationResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Aggregation URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION" ], "type": "string", "description": "Route Aggregation type" }, "uuid": { "type": "string", "description": "Route Aggregation identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHED", "DETACHED", "DETACHING", "FAILED", "PENDING_BGP_CONFIGURATION" ], "type": "string" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "ConnectionRouteAggregationData" }, "Fabric_attachConnectionRouteFilterResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Route filter URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER", "BGP_IPv6_PREFIX_FILTER" ], "type": "string", "description": "Route filter type" }, "uuid": { "type": "string", "description": "Route Filter identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHED", "DETACHED", "DETACHING", "FAILED", "PENDING_BGP_CONFIGURATION" ], "type": "string" }, "direction": { "enum": [ "INBOUND", "OUTBOUND" ], "type": "string" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "ConnectionRouteFilterData" }, "Fabric_attachPrivateServiceToProfileResult": { "required": [ "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "URL to the attached private service", "example": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387" }, "type": { "type": "string", "description": "Type of the private service or attachment", "example": "PRIVATE_SERVICE" }, "uuid": { "type": "string", "description": "Unique identifier for the private service", "example": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387" }, "attachmentStatus": { "type": "string", "description": "Status of the attachment operation", "example": "ATTACHED" } }, "x-fastmcp-top-level-schema": "AttachPrivateServiceResponse" }, "Fabric_attachServiceProfileToProfileResult": { "required": [ "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "URL to the attached service profile", "example": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387" }, "type": { "type": "string", "description": "Type of the service or attachment", "example": "SERVICE_PROFILE" }, "uuid": { "type": "string", "description": "Unique identifier for the service profile", "example": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387" }, "attachmentStatus": { "type": "string", "description": "Status of the attachment operation", "example": "ATTACHED" } }, "x-fastmcp-top-level-schema": "AttachServiceProfileResponse" }, "Fabric_attachTagToProfileResult": { "required": [ "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "URL to the attached tag", "example": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387" }, "type": { "type": "string", "description": "Type of the tag or attachment", "example": "TAG" }, "uuid": { "type": "string", "description": "Unique identifier for the tag", "example": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387" }, "attachmentStatus": { "type": "string", "description": "Status of the attachment operation", "example": "ATTACHED" } }, "x-fastmcp-top-level-schema": "AttachTagResponse" }, "Fabric_createAppDomainResult": { "required": [ "type", "name", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_DOMAIN" ], "type": "string", "description": "App Domain Type", "default": "APP_DOMAIN", "example": "APP_DOMAIN", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Domain name", "format": "string", "example": "atlassian.net", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Domain description", "format": "string", "example": "Atlassian Domain", "x-order": 5 }, "state": { "enum": [ "PENDING_VERIFICATION", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED" ], "type": "string", "description": "App Domain lifecycle state", "format": "string", "example": "PENDING_VERIFICATION", "x-order": 6 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_cbb82a68" } }, "description": "App Domain object", "x-fastmcp-top-level-schema": "AppDomain" }, "Fabric_createAppLinkResult": { "required": [ "type", "name", "router", "ipv4Subnet", "bandwidth", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 1 }, "type": { "enum": [ "APP_LINK" ], "type": "string", "description": "App Link Type", "default": "APP_LINK", "example": "APP_LINK", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "23cd19ab-d3bb-478b-9f25-bd12a3af1914", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Link name", "format": "string", "example": "Atlassian App Link", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Link description", "format": "string", "example": "Atlassian App Link in SV", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Link lifecycle state", "format": "string", "example": "PROVISIONING", "x-order": 6 }, "router": { "$ref": "#/components/schemas/Router_81684de7" }, "ipv4Subnet": { "type": "string", "description": "Customer-provided IP subnet for AppLink setup (/29 or larger subnet)", "example": "192.168.10.0/29", "x-order": 8 }, "ipv4Address": { "type": "string", "description": "App Link IP address", "format": "ipv4", "example": "192.168.10.1", "x-order": 9 }, "bandwidth": { "type": "integer", "description": "App Link aggregated data transfer capacity in Mbps", "example": 1000, "x-order": 10 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_83160f21" } }, "description": "App Link object", "x-fastmcp-top-level-schema": "AppLink" }, "Fabric_createAppServiceResult": { "required": [ "type", "name" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 1 }, "type": { "enum": [ "APP_SERVICE" ], "type": "string", "description": "App Service Type", "default": "APP_SERVICE", "example": "APP_SERVICE", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "5008a109-9d1c-485c-b0ba-de9736f283c2", "x-order": 3 }, "name": { "type": "string", "description": "Customer-provided App Service name", "format": "string", "example": "Atlassian App Service", "x-order": 4 }, "description": { "type": "string", "description": "Customer-provided App Service description", "format": "string", "example": "Atlassian App Service in SV", "x-order": 5 }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Service lifecycle state", "example": "PROVISIONING", "x-order": 6 }, "endpoint": { "type": "string", "description": "Accessible endpoint through this service", "example": "equinixjira.atlassian.net", "x-order": 7 }, "sourceDomains": { "type": "array", "items": { "type": "string", "example": "equinix.com" }, "description": "List of source domains from where traffic is allowed", "x-order": 8 }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_0b77c634" } }, "description": "App Service object", "x-fastmcp-top-level-schema": "AppService" }, "Fabric_createAppSubscriptionResult": { "required": [ "type", "source", "target", "project" ], "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 1 }, "type": { "enum": [ "APP_SUBSCRIPTION" ], "type": "string", "description": "App Subscription Type", "default": "APP_SUBSCRIPTION", "example": "APP_SUBSCRIPTION", "x-order": 2 }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "x-order": 3 }, "source": { "$ref": "#/components/schemas/Source" }, "target": { "$ref": "#/components/schemas/Target" }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Subscription lifecycle state", "example": "PROVISIONING", "x-order": 6 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_7b17b91f" } }, "description": "App Subscription object", "x-fastmcp-top-level-schema": "AppSubscription" }, "Fabric_createAsnResult": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string", "description": "Unique identifier for the ASN record", "format": "uuid", "example": "6db706f8-2a37-4546-a3ed-1df113a84d43" }, "state": { "$ref": "#/components/schemas/State_a5c353e9" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "number": { "type": "integer", "description": "Autonomous System Number", "format": "int64", "example": 64497 }, "rirRegion": { "enum": [ "AFRINIC", "APNIC", "ARIN", "LACNIC", "RIPE_NCC" ], "type": "string", "description": "Regional Internet Registry region" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "range": { "enum": [ "16_BIT", "32_BIT" ], "type": "string", "description": "ASN range selection" }, "ownershipChallengeDetails": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "RPKI", "LOA" ], "type": "string", "description": "Type of ownership challenge", "x-enum-varnames": [ "RPKI", "LOA" ] } }, "description": "Ownership challenge details for public ASN verification" }, "change": { "type": "object", "properties": { "href": { "type": "string", "description": "URL path to the change event", "example": "/cloudEvents" } }, "description": "Change reference for ASN" }, "assets": { "$ref": "#/components/schemas/Assets_7c79a22a" }, "errors": { "$ref": "#/components/schemas/Errors_81abeebb" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "ASN Record", "x-fastmcp-top-level-schema": "Asn" }, "Fabric_createCloudRouterActionResult": { "required": [ "type", "uuid", "state", "changeLog" ], "type": "object", "properties": { "type": { "enum": [ "BGP_SESSION_STATUS_UPDATE", "ROUTE_TABLE_ENTRY_UPDATE", "RECEIVED_ROUTE_ENTRY_UPDATE", "ADVERTISED_ROUTE_ENTRY_UPDATE" ], "type": "string", "description": "Cloud router action type" }, "uuid": { "type": "string", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" }, "description": { "type": "string", "example": "description" }, "state": { "enum": [ "SUCCEEDED", "FAILED", "PENDING" ], "type": "string", "description": "Cloud router action state" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "href": { "type": "string", "example": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9" }, "connection": { "$ref": "#/components/schemas/Connection_aa288f10" }, "router": { "$ref": "#/components/schemas/Router_2239ca95" } }, "description": "Cloud router actions response object", "x-fastmcp-top-level-schema": "CloudRouterActionResponse" }, "Fabric_createCloudRouterCommandResult": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/commands/1e9414f1-763e-4c0a-86c6-0bc8336048d9" }, "type": { "enum": [ "PING_COMMAND", "TRACEROUTE_COMMAND" ], "type": "string", "description": "Fabric Cloud Router Command Type", "example": "PING_COMMAND" }, "uuid": { "type": "string", "format": "uuid", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" }, "name": { "type": "string", "description": "Customer-provided Cloud Router name", "format": "string", "example": "test-fg-1" }, "description": { "type": "string", "example": "description" }, "state": { "enum": [ "PENDING", "SUCCEEDED", "FAILED", "DELETED" ], "type": "string", "description": "Fabric Cloud Router Command State", "example": "SUCCEEDED" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "request": { "$ref": "#/components/schemas/Request" }, "response": { "$ref": "#/components/schemas/Response_1421a8cf" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Get Fabric Cloud Router Command response object", "x-fastmcp-top-level-schema": "CloudRouterCommand" }, "Fabric_createCloudRouterResult_0cce220a": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Fabric_createCloudRouterResult_63f39c25" } ], "properties": { "href": { "type": "string", "description": "Cloud Routers URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "name": { "type": "string", "description": "Customer-provided Cloud Router name", "format": "string", "example": "test-fg-1" }, "state": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "REPROVISIONING", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Access point lifecycle state", "example": "PROVISIONED" }, "equinixAsn": { "type": "integer", "description": "Equinix ASN", "format": "int64", "example": 30000 }, "connectionsCount": { "minimum": 0.0, "type": "integer", "description": "Number of connections associated with this Access point" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_3a596f52" } }, "description": "Fabric Cloud Router object", "x-fastmcp-top-level-schema": "CloudRouter" }, "Fabric_createCloudRouterResult_63f39c25": { "type": "object", "properties": { "type": { "enum": [ "XF_ROUTER" ], "type": "string" }, "name": { "type": "string", "description": "Customer-provided Cloud Router name" }, "location": { "$ref": "#/components/schemas/Location_32724e48" }, "package": { "$ref": "#/components/schemas/Package" }, "order": { "$ref": "#/components/schemas/Order_3e7328e1" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_903ff2b6" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" } }, "description": "Create Cloud Router" }, "Fabric_createCompanyProfileResult": { "type": "object", "properties": { "href": { "type": "string", "example": "https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000" }, "uuid": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "type": "string", "example": "COMPANY_PROFILE" }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "example": "Equinix" }, "summary": { "maxLength": 125, "minLength": 1, "type": "string", "example": "Global interconnection and data center company" }, "description": { "maxLength": 450, "minLength": 1, "type": "string", "example": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers." }, "state": { "type": "string", "description": "Company Profile State" }, "metros": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "metroCode": { "type": "string" } } }, "example": [ { "href": "https://api.equinix.com/fabric/v4/metros/SV", "metroCode": "SV" } ] }, "logo": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string" }, "extensionType": { "type": "string" } } }, "tags": { "$ref": "#/components/schemas/Tags_d567d07b" }, "serviceProfiles": { "$ref": "#/components/schemas/ServiceProfiles" }, "privateServices": { "$ref": "#/components/schemas/PrivateServices" }, "pointOfContacts": { "$ref": "#/components/schemas/PointOfContacts" }, "notifications": { "$ref": "#/components/schemas/Notifications_ebd7698b" }, "overview": { "type": "string", "example": "About Initech Corp

lorem ipsum

" }, "webUrl": { "type": "string", "example": "https://www.equinix.com" }, "contactUrl": { "type": "string", "example": "https://www.equinix.com/contact-us" }, "change": { "$ref": "#/components/schemas/Change_f9a00c8a" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "CompanyProfileResponse" }, "Fabric_createConnectionResult": { "required": [ "type", "name", "bandwidth", "aSide", "zSide" ], "type": "object", "properties": { "href": { "type": "string", "description": "Connection URI", "format": "uri" }, "type": { "enum": [ "EVPL_VC", "EPL_VC", "EC_VC", "IP_VC", "ACCESS_EPL_VC", "EIA_VC", "EVPLAN_VC", "EPLAN_VC", "EVPTREE_VC", "EPTREE_VC", "IPWAN_VC", "IA_VC", "MC_VC", "IX_VC", "GW_VC", "IPX_VC" ], "type": "string", "description": "Connection type" }, "uuid": { "type": "string", "description": "Equinix-assigned connection identifier" }, "name": { "type": "string", "description": "Customer-provided connection name" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "change": { "$ref": "#/components/schemas/Change_c09663d1" }, "operation": { "$ref": "#/components/schemas/Operation_e2c43536" }, "order": { "$ref": "#/components/schemas/Order_3e7328e1" }, "notifications": { "$ref": "#/components/schemas/Notifications_903ff2b6" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "bandwidth": { "maximum": 10000.0, "minimum": 0.0, "type": "integer", "description": "Connection bandwidth in Mbps" }, "geoScope": { "enum": [ "CANADA", "CONUS", "JAPAN", "UK", "AUSTRALIA", "BRAZIL", "SWITZERLAND", "EU" ], "type": "string", "description": "Geographic boundary for this connection" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_03b2b702" }, "isRemote": { "type": "boolean", "description": "Connection property derived from access point locations" }, "direction": { "enum": [ "INTERNAL", "INCOMING", "OUTGOING" ], "type": "string", "description": "Connection directionality from the requester point of view" }, "aSide": { "$ref": "#/components/schemas/ASide_cdc3f780" }, "zSide": { "$ref": "#/components/schemas/ASide_cdc3f780" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" }, "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Connection additional information" }, "project": { "$ref": "#/components/schemas/Project_12b4cec8" } }, "description": "Connection specification", "x-fastmcp-top-level-schema": "Connection" }, "Fabric_createConnectionRoutingProtocolResult_09093292": { "type": "object", "properties": { "type": { "enum": [ "DIRECT" ], "type": "string", "description": "Routing protocol type" }, "name": { "type": "string", "example": "My-direct-route-1" }, "directIpv4": { "type": "object", "properties": { "equinixIfaceIp": { "type": "string", "description": "Equinix side Interface IP address", "example": "192.168.100.0/30" } } }, "directIpv6": { "required": [ "equinixIfaceIp" ], "type": "object", "properties": { "equinixIfaceIp": { "type": "string", "description": "Equinix side Interface IP address", "example": "2001:db8:c59b::/1" } } }, "href": { "type": "string", "description": "Routing Protocol URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5" }, "uuid": { "type": "string", "description": "Routing protocol identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "state": { "enum": [ "PROVISIONED", "DEPROVISIONED", "PROVISIONING", "DEPROVISIONING", "REPROVISIONING", "FAILED" ], "type": "string" }, "operation": { "$ref": "#/components/schemas/Operation_6c0cfed5" }, "change": { "$ref": "#/components/schemas/Change_7f4a8672" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Uniquely identifies a project" } }, "description": "The Routing Protocol's project" }, "connection": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Equinix-assigned connection identifier" }, "platformUuid": { "type": "string", "description": "Equinix-assigned platform connection identifier" } }, "description": "Connection specification" } } }, "Fabric_createConnectionRoutingProtocolResult_a1b7bd9c": { "type": "object", "properties": { "type": { "enum": [ "BGP", "DIRECT" ], "type": "string", "description": "Routing protocol type" } }, "x-fastmcp-top-level-schema": "RoutingProtocolData", "anyOf": [ { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_ddceab00" }, { "$ref": "#/components/schemas/Fabric_createConnectionRoutingProtocolResult_09093292" } ] }, "Fabric_createConnectionRoutingProtocolResult_ddceab00": { "type": "object", "properties": { "type": { "enum": [ "BGP" ], "type": "string", "description": "Routing protocol type" }, "name": { "type": "string", "example": "My-BGP-route-1" }, "bgpIpv4": { "$ref": "#/components/schemas/BgpIpv4_c8b763be" }, "bgpIpv6": { "$ref": "#/components/schemas/BgpIpv6" }, "customerAsn": { "type": "integer", "description": "Customer asn", "format": "int64", "example": 65002 }, "equinixAsn": { "type": "integer", "description": "Equinix asn", "format": "int64", "example": 65002 }, "bgpAuthKey": { "type": "string", "description": "BGP authorization key", "example": "testAuthKey" }, "asOverrideEnabled": { "type": "boolean", "description": "Enable AS number override" }, "bfd": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "interval": { "type": "string", "example": "100" } } }, "href": { "type": "string", "description": "Routing Protocol URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5" }, "uuid": { "type": "string", "description": "Routing protocol identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "state": { "enum": [ "PROVISIONED", "DEPROVISIONED", "PROVISIONING", "DEPROVISIONING", "REPROVISIONING", "FAILED" ], "type": "string" }, "operation": { "$ref": "#/components/schemas/Operation_6c0cfed5" }, "change": { "$ref": "#/components/schemas/Change_7f4a8672" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Uniquely identifies a project" } }, "description": "The Routing Protocol's project" }, "connection": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Equinix-assigned connection identifier" }, "platformUuid": { "type": "string", "description": "Equinix-assigned platform connection identifier" } }, "description": "Connection specification" } } }, "Fabric_createConnectionRoutingProtocolsInBulkResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_88a1364d" } }, "x-fastmcp-top-level-schema": "GetResponse" }, "Fabric_createCrossConnectResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Cross Connect URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743" }, "type": { "enum": [ "XC" ], "type": "string", "description": "Type of Cross Connect.", "example": "XC" }, "uuid": { "type": "string", "description": "Cross Connect Identifier.", "format": "uuid", "example": "46bb1a31-c28f-4197-8b10-06e0e03d0743" }, "name": { "type": "string", "description": "A short, descriptive name for this Cross Connect.", "example": "My-CC-service" }, "state": { "enum": [ "PENDING", "PENDING_ACTION", "PROVISIONING", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONED", "CANCELLING", "CANCELLED", "FAILED" ], "type": "string", "description": "Cross Connect State.", "example": "PENDING" }, "allowedActions": { "$ref": "#/components/schemas/AllowedActions" }, "bmmrType": { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "Cross Connect BMMR Type.", "example": "EQUINIX" }, "mediaType": { "type": "string", "description": "Media type of the Cross Connect.", "example": "SINGLE_MODE_FIBER" }, "mediaSubType": { "type": "string", "description": "Media sub-type of the Cross Connect.", "example": "SINGLE_MODE_FIBER" }, "circuitId": { "type": "string", "description": "Circuit identifier of the Cross Connect." }, "serialNumber": { "type": "string", "description": "Serial number of the Cross Connect.", "example": "234567890" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_b237089f" }, "aSide": { "$ref": "#/components/schemas/CrossConnectASideResponse" }, "zSide": { "$ref": "#/components/schemas/CrossConnectZSideResponse" }, "account": { "type": "object", "properties": { "accountNumber": { "type": "integer", "description": "Account number.", "format": "int64", "example": 123456 } }, "description": "Account the Cross Connect belongs to." }, "notifications": { "$ref": "#/components/schemas/Notifications_7cbe42a5" }, "order": { "$ref": "#/components/schemas/Order_41b238f5" }, "links": { "$ref": "#/components/schemas/Links_b5ec80bd" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_a9aa0994" } }, "description": "Cross Connect Response.", "x-fastmcp-top-level-schema": "CrossConnectResponse" }, "Fabric_createEiaServiceResult": { "required": [ "href", "type", "uuid", "name", "state", "change", "routingProtocol", "billing", "account", "project", "order", "changeLog", "useCase" ], "type": "object", "properties": { "href": { "type": "string", "description": "Service URL path", "format": "uri", "example": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4" }, "type": { "enum": [ "SINGLE_IA", "DUAL_IA" ], "type": "string", "description": "Type of the service, either single or dual internet access", "x-enum-varnames": [ "SINGLE_IA", "DUAL_IA" ] }, "uuid": { "type": "string", "description": "Unique identifier for the EIA Service", "format": "uuid" }, "name": { "type": "string", "description": "The name of the EIA Service" }, "bandwidth": { "type": "integer", "description": "Bandwidth of the service" }, "bandwidthCommit": { "type": "integer", "description": "Minimum bandwidth commit for burst billing variant of the service" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "FAILED", "DEPROVISIONING", "DEPROVISIONED" ], "type": "string", "description": "Current state of the service", "x-enum-varnames": [ "PROVISIONING", "PROVISIONED", "FAILED", "DEPROVISIONING", "DEPROVISIONED" ] }, "change": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the change object", "format": "uri" } } }, "locations": { "$ref": "#/components/schemas/Locations_cc851082" }, "routingProtocol": { "$ref": "#/components/schemas/RoutingProtocol_3cbb1e72" }, "billing": { "$ref": "#/components/schemas/Billing_e95cc35e" }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account number" }, "href": { "type": "string", "description": "Account URL path", "format": "uri", "example": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234" } } }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "order": { "$ref": "#/components/schemas/Order_756ea9ac" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "useCase": { "enum": [ "MAIN", "MANAGEMENT_ACCESS" ], "type": "string", "x-enum-varnames": [ "MAIN", "MANAGEMENT_ACCESS" ] } }, "x-fastmcp-top-level-schema": "InternetAccessService" }, "Fabric_createExchangeServiceResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Internet Exchange Service URI", "example": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011" }, "uuid": { "type": "string", "description": "Internet Exchange Service identifier", "format": "uuid", "example": "a8ba52de-faae-43b5-b0b1-6904d37ee011" }, "type": { "enum": [ "IX" ], "type": "string", "description": "Internet Exchange Service Type", "default": "IX", "example": "IX" }, "name": { "type": "string", "description": "Name", "example": "ix_exchange_service" }, "bandwidth": { "type": "integer", "description": "bandwidth in Mbps", "example": 400000 }, "description": { "type": "string", "description": "Description", "example": "ix_exchange_service" }, "state": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PENDING_ACTIVATION", "ACTIVATING", "ACTIVATING_FAILED", "PROVISIONED", "REPROVISIONING", "REPROVISIONING_FAILED", "DEPROVISIONING", "DEPROVISIONED", "DEPROVISIONING_FAILED" ], "type": "string", "description": "State", "example": "PROVISIONING" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "publicPeeringConnection": { "$ref": "#/components/schemas/PublicPeeringConnection" }, "routingProtocol": { "$ref": "#/components/schemas/RoutingProtocol_61df553d" }, "order": { "$ref": "#/components/schemas/Order_42dc2ad5" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_a0ca161e" }, "changelog": { "$ref": "#/components/schemas/Changelog" }, "additionalInfo": { "$ref": "#/components/schemas/AdditionalInfo_35e07328" } }, "x-fastmcp-top-level-schema": "ExchangeServiceResponse" }, "Fabric_createLoaResult": { "type": "object", "properties": { "href": { "type": "string", "description": "URI of this LOA resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2" }, "uuid": { "type": "string", "description": "Unique identifier of this LOA.", "format": "uuid", "example": "29cc7878-54e3-4e1a-8651-87a61354bac2" }, "type": { "enum": [ "CAGE_LOA", "PATCH_PANEL_LOA", "PATCH_PANEL_PORT_LOA" ], "type": "string", "description": "Type of Letter of Authorization\n", "example": "PATCH_PANEL_PORT_LOA" }, "name": { "type": "string", "description": "A short, descriptive name for this LOA", "example": "LOA-Equinix-SV1-2026" }, "description": { "type": "string", "description": "Additional context about this LOA", "example": "Authorization for patch panel port access to Equinix at SV1" }, "authorizedProductType": { "enum": [ "XC", "XF_PORT", "VD" ], "type": "string", "description": "Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge\n", "example": "XC" }, "state": { "enum": [ "PENDING", "FAILED", "PENDING_AUTHORIZATION", "PENDING_ACCEPTANCE", "CANCELLED", "INACTIVE", "ACTIVE", "EXPIRED" ], "type": "string", "description": "Current lifecycle state of the LOA.", "example": "ACTIVE" }, "operation": { "type": "object", "properties": { "consumersCount": { "type": "integer", "description": "Number of consumers associated with this LOA.", "example": 10 } } }, "requestor": { "$ref": "#/components/schemas/Requestor" }, "issuer": { "$ref": "#/components/schemas/Issuer" }, "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_27ae5d2c" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "IBX Code", "example": "AM1" } }, "description": "Eligible location where LOA can be issued." }, "expirationDateTime": { "type": "string", "description": "Date and time when this LOA expires.
Default to 3 months from the creation date\n", "format": "date-time", "example": "2026-11-06T07:00:00Z" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_c32c50f9" } }, "description": "Loa Response", "x-fastmcp-top-level-schema": "LoaResponse" }, "Fabric_createLogoResult": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "example": "https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0" }, "uuid": { "type": "string", "format": "uuid", "example": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0" }, "type": { "type": "string", "description": "Type of logo", "example": "COMPANY_LOGO" }, "name": { "type": "string", "example": "Equinix Logo" }, "description": { "type": "string", "example": "Company branding logo" }, "status": { "type": "string", "example": "CREATED" }, "extensionType": { "type": "string", "example": ".png" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Equinix Fabric Logo Response Object", "x-fastmcp-top-level-schema": "LogoResponse" }, "Fabric_createNetworkResult_32127b47": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Fabric_createNetworkResult_a6b74c70" }, { "$ref": "#/components/schemas/Fabric_createNetworkResult_88b5d778" } ], "description": "Network specification", "x-fastmcp-top-level-schema": "Network" }, "Fabric_createNetworkResult_88b5d778": { "required": [ "type", "name", "scope", "notifications" ], "type": "object", "properties": { "type": { "enum": [ "EVPLAN", "EPLAN", "IPWAN", "EVPTREE", "EPTREE" ], "type": "string", "description": "Network type" }, "name": { "type": "string", "description": "Customer-provided network name" }, "scope": { "enum": [ "REGIONAL", "GLOBAL", "LOCAL" ], "type": "string", "description": "Network scope" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "notifications": { "$ref": "#/components/schemas/Notifications_4779732b" } }, "description": "Create Network" }, "Fabric_createNetworkResult_a6b74c70": { "required": [ "href", "uuid", "state", "changeLog" ], "type": "object", "properties": { "href": { "type": "string", "description": "Network URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784" }, "uuid": { "type": "string", "description": "Equinix-assigned network identifier", "format": "uuid", "example": "92dc376a-a932-43aa-a6a2-c806dedbd784" }, "state": { "enum": [ "ACTIVE", "INACTIVE", "DELETED" ], "type": "string", "description": "Network status", "example": "ACTIVE" }, "connectionsCount": { "type": "number", "description": "number of connections created on the network" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "change": { "$ref": "#/components/schemas/Change_18dae99f" }, "operation": { "type": "object", "properties": { "equinixStatus": { "enum": [ "PROVISIONING", "PROVISIONED", "NOT_PROVISIONED", "DEPROVISIONING", "DEPROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Network status" } }, "description": "Network operational data" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "links": { "$ref": "#/components/schemas/Links_3706c0c8" } } }, "Fabric_createOpticalConnectResult": { "type": "object", "properties": { "href": { "type": "string", "description": "URI of this Optical Connect resource.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0" }, "uuid": { "type": "string", "description": "Unique identifier of this Optical Connect.", "format": "uuid", "example": "06dbb0e3-e55d-4090-8aff-fc5654abaad0" }, "type": { "enum": [ "OC" ], "type": "string", "description": "Connection Type.
OC - Optical Connect.\n", "example": "OC" }, "name": { "type": "string", "description": "Equinix-assigned name, derived from the account number and the two IBX locations.\n", "example": "123456-SV1-SV2-01" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "PROVISIONING_FAILED", "REPROVISIONING", "REPROVISIONING_FAILED", "DEPROVISIONING", "DEPROVISIONED" ], "type": "string", "description": "Optical Connect lifecycle states.", "example": "PROVISIONED" }, "bandwidth": { "type": "integer", "description": "Provisioned connection bandwidth in Mbps.", "example": 10000 }, "connectionDestinationType": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
\n" }, "pathType": { "$ref": "#/components/schemas/PathType_2d3cf468" }, "bmmrType": { "enum": [ "EQUINIX", "SELF" ], "type": "string", "description": "BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.\n" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_e8c4a2d1" }, "aSide": { "$ref": "#/components/schemas/ASide_cc9f4f57" }, "zSide": { "$ref": "#/components/schemas/ZSide_def831f6" }, "order": { "$ref": "#/components/schemas/Order_95704d9c" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_57addba0" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Optical Metro Connect connection with its current state and the resolved\n physical termination points at both ends.", "x-fastmcp-top-level-schema": "OpticalConnectResponse" }, "Fabric_createPortResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", "format": "uri" }, "type": { "enum": [ "XF_PORT" ], "type": "string", "description": "Type of Port" }, "uuid": { "type": "string", "description": "Equinix assigned response attribute for port identifier", "format": "uuid" }, "name": { "type": "string", "description": "Equinix assigned response attribute for Port name" }, "description": { "type": "string", "description": "Equinix assigned response attribute for Port description" }, "physicalPortsSpeed": { "minimum": 0.0, "type": "integer", "description": "Physical Ports Speed in Mbps" }, "connectionsCount": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Connection count" }, "physicalPortsType": { "enum": [ "1000BASE_LX", "10GBASE_LR", "100GBASE_LR4", "10GBASE_ER", "1000BASE_SX", "10GBASE_SMF", "400GBASE_LR4" ], "type": "string", "description": "Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports" }, "physicalPortsCount": { "type": "integer" }, "connectivitySourceType": { "enum": [ "COLO", "BMMR", "REMOTE" ], "type": "string", "description": "Port connectivity type" }, "bmmrType": { "enum": [ "SELF", "EQUINIX" ], "type": "string" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "state": { "enum": [ "PENDING", "PROVISIONING", "REPROVISIONING", "PENDING_CROSS_CONNECT", "PROVISIONED", "ACTIVE", "DEPROVISIONING", "DEPROVISIONED", "INACTIVE", "FAILED", "ADDED", "DELETED", "TO_BE_ADDED", "TO_BE_DELETED" ], "type": "string", "description": "Port lifecycle state" }, "order": { "$ref": "#/components/schemas/Order_9b002780" }, "operation": { "$ref": "#/components/schemas/Operation_2a3fcb9f" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "change": { "$ref": "#/components/schemas/Change_aad47080" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "serviceType": { "enum": [ "EPL", "MSP" ], "type": "string", "description": "Port service Type" }, "serviceCode": { "enum": [ "CX", "IX", "IA", "MC" ], "type": "string", "description": "Identifies the service type associated with this port" }, "bandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port bandwidth in Mbps" }, "availableBandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port available bandwidth in Mbps" }, "usedBandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port used bandwidth in Mbps" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "device": { "$ref": "#/components/schemas/Device_b2172721" }, "interface": { "type": "object", "properties": { "type": { "type": "string", "description": "Port interface type" } }, "description": "Port interface" }, "demarcationPointIbx": { "type": "string", "description": "A-side/Equinix ibx" }, "tetherIbx": { "type": "string", "description": "z-side/Equinix ibx" }, "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_970747e9" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_616e679f" }, "encapsulation": { "type": "object", "properties": { "type": { "enum": [ "DOT1Q", "QINQ", "UNTAGGED" ], "type": "string", "description": "Port encapsulation protocol type" }, "tagProtocolId": { "type": "string", "description": "Port encapsulation tag protocol identifier" } }, "description": "Port encapsulation configuration" }, "lagEnabled": { "type": "boolean", "description": "If LAG enabled" }, "lag": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "id" }, "enabled": { "type": "boolean", "description": "enabled" }, "name": { "type": "string", "description": "name" }, "memberStatus": { "type": "string", "description": "member status" } }, "description": "Port Lag" } ] }, "asn": { "type": "integer", "description": "Port ASN" }, "package": { "type": "object", "properties": { "code": { "enum": [ "STANDARD", "UNLIMITED", "UNLIMITED_PLUS" ], "type": "string", "description": "Type of Port Package" } }, "description": "Package settings for port" }, "settings": { "$ref": "#/components/schemas/Settings_10b6d98e" }, "physicalPortQuantity": { "type": "integer", "description": "Number of physical ports" }, "notifications": { "$ref": "#/components/schemas/Notifications_ccb07798" }, "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Port additional information" }, "physicalPorts": { "$ref": "#/components/schemas/PhysicalPorts" }, "loas": { "type": "array", "items": { "properties": { "uuid": { "type": "string", "description": "uuid" }, "type": { "type": "string", "description": "Loa type", "example": "DIGITAL_LOA" } }, "description": "Port Loas" }, "description": "Port Loas" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" } }, "description": "Port specification", "x-fastmcp-top-level-schema": "Port" }, "Fabric_createRouteAggregationResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Aggregation URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION", "BGP_IPv6_PREFIX_AGGREGATION" ], "type": "string", "description": "Route Aggregation type" }, "uuid": { "type": "string", "description": "Route Aggregation identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "name": { "type": "string", "example": "My-direct-route-1" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "change": { "$ref": "#/components/schemas/Change_28881cd4" }, "connectionsCount": { "type": "integer", "example": 0 }, "rulesCount": { "type": "integer", "example": 0 }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" }, "href": { "type": "string", "description": "Project URI", "format": "uri" } } }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "RouteAggregationsData" }, "Fabric_createRouteAggregationRuleResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Aggregation Rules URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b" }, "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION_RULE" ], "type": "string", "description": "Route Aggregation type" }, "uuid": { "type": "string", "description": "Route Aggregation Rule identifier", "format": "uuid", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" }, "name": { "type": "string", "example": "Private-subnet-aggregation-2" }, "description": { "type": "string", "description": "Customer-provided Route Aggregation Rule description" }, "state": { "enum": [ "PROVISIONING", "REPROVISIONING", "DEPROVISIONING", "PROVISIONED", "DEPROVISIONED", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Route Aggregation Rule status" }, "change": { "$ref": "#/components/schemas/Change_47ab42a6" }, "prefix": { "type": "string", "example": "192.168.0.0/24" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "RouteAggregationRulesData" }, "Fabric_createRouteAggregationRulesInBulkResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_f46a25cc" } }, "x-fastmcp-top-level-schema": "GetRouteAggregationRulesResponse" }, "Fabric_createRouteFilterResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Route filter URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER", "BGP_IPv6_PREFIX_FILTER" ], "type": "string", "description": "Route Filter type" }, "uuid": { "type": "string", "description": "Route filter identifier", "format": "uuid", "example": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d" }, "name": { "type": "string", "example": "My-direct-route-1" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "change": { "$ref": "#/components/schemas/Change_2554fe61" }, "notMatchedRuleAction": { "enum": [ "ALLOW", "DENY" ], "type": "string" }, "connectionsCount": { "type": "integer", "example": 0 }, "rulesCount": { "type": "integer", "example": 0 }, "project": { "$ref": "#/components/schemas/Project_812bd497" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "RouteFiltersData" }, "Fabric_createRouteFilterRuleResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Route Filter Rules URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b" }, "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER_RULE", "BGP_IPv6_PREFIX_FILTER_RULE" ], "type": "string", "description": "Route filter type" }, "uuid": { "type": "string", "description": "Route Filter Rule identifier", "format": "uuid", "example": "65b025ef-022b-4180-85cf-82cfc1ab655b" }, "name": { "type": "string", "example": "Private-subnet-filter-2" }, "description": { "type": "string", "description": "Customer-provided Route Filter Rule description" }, "state": { "enum": [ "PROVISIONING", "REPROVISIONING", "DEPROVISIONING", "PROVISIONED", "DEPROVISIONED", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Route filter rule status" }, "prefixMatch": { "type": "string", "description": "prefix matching operator", "default": "orlonger", "example": "exact" }, "change": { "$ref": "#/components/schemas/Change_979fb309" }, "action": { "enum": [ "PERMIT", "DENY" ], "type": "string" }, "prefix": { "type": "string", "example": "192.168.0.0/24" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "RouteFilterRulesData" }, "Fabric_createRouteFilterRulesInBulkResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_fbbbdffe" } }, "x-fastmcp-top-level-schema": "GetRouteFilterRulesResponse" }, "Fabric_createServiceProfileResult": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Profile" } ], "properties": { "state": { "enum": [ "ACTIVE", "PENDING_APPROVAL", "DELETED", "REJECTED" ], "type": "string", "description": "Equinix assigned state.", "example": "ACTIVE" }, "account": { "$ref": "#/components/schemas/Account_c1695b98" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "change": { "$ref": "#/components/schemas/Change_252edc53" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_94e8bdf1" } }, "description": "Service Profile is a software definition for a named provider service and it's network connectivity requirements.\nThis includes the basic marketing information and one\nor more sets of access points (a set per each access point type) fulfilling the provider service.\n", "x-fastmcp-top-level-schema": "ServiceProfile" }, "Fabric_createServiceTokenResult": { "type": "object", "properties": { "type": { "enum": [ "VC_TOKEN", "EPL_TOKEN" ], "type": "string", "description": "Type of Service Token" }, "href": { "type": "string", "description": "An absolute URL that is the subject of the link's context.", "format": "uri" }, "expiry": { "type": "integer" }, "uuid": { "type": "string", "description": "Equinix-assigned service token identifier", "format": "uuid" }, "issuerSide": { "type": "string", "description": "information about token side" }, "name": { "type": "string", "description": "Customer-provided service token name" }, "description": { "type": "string", "description": "Customer-provided service token description" }, "expirationDateTime": { "type": "string", "description": "Expiration date and time of the service token.", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "connection": { "$ref": "#/components/schemas/Connection_dd127cea" }, "state": { "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "DELETED" ], "type": "string", "description": "Service token state" }, "notifications": { "$ref": "#/components/schemas/Notifications_9750afd0" }, "account": { "$ref": "#/components/schemas/Account_8518334f" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } }, "description": "Project is optional for AM-CRH customers. If not provided, a default project will be assigned." } }, "description": "Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.", "x-fastmcp-top-level-schema": "ServiceToken" }, "Fabric_createStreamAlertRulesResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream Alert Rule URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "METRIC_ALERT" ], "type": "string", "description": "Stream subscription type" }, "name": { "type": "string", "description": "Customer-provided stream alert rule name" }, "description": { "type": "string", "description": "Customer-provided stream alert rule description" }, "state": { "enum": [ "ACTIVE", "INACTIVE" ], "type": "string", "description": "Steam subscription provision state" }, "enabled": { "type": "boolean", "description": "Stream alert rule enabled status", "default": true }, "metricSelector": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string", "example": "equinix.fabric.metro.sv_da.latency" }, "description": "Stream alert rule filtered by metric name" } } }, "resourceSelector": { "$ref": "#/components/schemas/ResourceSelector_30b32894" }, "detectionMethod": { "$ref": "#/components/schemas/DetectionMethod_3af096e5" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Stream object", "x-fastmcp-top-level-schema": "StreamAlertRule" }, "Fabric_createStreamSubscriptionsResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream Subscription URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "STREAM_SUBSCRIPTION" ], "type": "string", "description": "type" }, "name": { "type": "string", "description": "Customer-provided subscription name" }, "description": { "type": "string", "description": "Customer-provided subscription description" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "REPROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string", "description": "Steam subscription provision state" }, "enabled": { "type": "boolean", "description": "Stream subscription enabled status" }, "metricSelector": { "$ref": "#/components/schemas/MetricSelector" }, "eventSelector": { "$ref": "#/components/schemas/MetricSelector" }, "sink": { "$ref": "#/components/schemas/Sink_2cb28b2c" }, "operation": { "$ref": "#/components/schemas/Operation_4b006c02" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Stream Subscription object", "x-fastmcp-top-level-schema": "StreamSubscription" }, "Fabric_createStreamsResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/streams/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "TELEMETRY_STREAM" ], "type": "string", "description": "type" }, "name": { "type": "string", "description": "Customer-provided stream name" }, "description": { "type": "string", "description": "Customer-provided stream description" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "notifications": { "$ref": "#/components/schemas/Notifications_0246edb6" }, "state": { "enum": [ "PROVISIONING", "PROVISIONED", "REPROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string", "description": "Stream provision state" }, "assetsCount": { "type": "integer", "description": "Stream assets count", "example": 1 }, "streamSubscriptionsCount": { "type": "integer", "description": "Stream subscriptions count", "example": 2 }, "alertRulesCount": { "type": "integer", "description": "Stream alert rules count", "example": 3 }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Stream object", "x-fastmcp-top-level-schema": "Stream" }, "Fabric_createTagResult": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "example": "https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0" }, "uuid": { "type": "string", "format": "uuid", "example": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0" }, "type": { "type": "string", "example": "PREDEFINED_TAG" }, "name": { "type": "string", "example": "equinix.fabric.spotlight.ai.llm" }, "displayName": { "type": "string", "example": "LLM" }, "state": { "enum": [ "APPROVED", "PENDING_APPROVAL", "REJECTED" ], "type": "string", "description": "Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT", "example": "PENDING_APPROVAL" }, "notifications": { "$ref": "#/components/schemas/Notifications_ebd7698b" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "weight": { "type": "integer", "example": 30000 } }, "description": "Equinix Fabric Tag Response Object", "x-fastmcp-top-level-schema": "TagResponse" }, "Fabric_deleteIpBlockByIdResult": { "required": [ "uuid", "href", "state", "type", "ownership", "prefixLength", "project", "changeLog" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier for the IP Block", "format": "uuid" }, "href": { "type": "string", "description": "Resource URL path for the IP Block", "example": "/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb" }, "type": { "enum": [ "IPV4_IP_BLOCK", "IPV6_IP_BLOCK" ], "type": "string", "x-enum-varnames": [ "IPV4_IP_BLOCK", "IPV6_IP_BLOCK" ] }, "state": { "enum": [ "PENDING", "ACTIVE", "DELETING", "DELETED", "FAILED" ], "type": "string", "description": "Current state of the IP Block" }, "ownership": { "enum": [ "EQUINIX", "CUSTOMER" ], "type": "string", "description": "IpBlockOwnership of the IP Block" }, "location": { "required": [ "metroCode" ], "type": "object", "properties": { "metroHref": { "type": "string", "description": "Metro URL path for the linked resource", "example": "https://api.equinix.com/fabric/v4/metros/WA" }, "metroCode": { "pattern": "^[A-Z]{2}$", "type": "string", "example": "WA" } } }, "prefixLength": { "maximum": 128.0, "minimum": 1.0, "type": "integer", "description": "IpBlockPrefix length" }, "prefix": { "type": "string", "description": "CIDR prefix" }, "order": { "required": [ "href", "orderNumber" ], "type": "object", "properties": { "href": { "type": "string", "description": "Order URI", "format": "uri", "example": "https://api.equinix.com/colocations/v2/orders/1-34834234" }, "orderNumber": { "type": "string", "description": "Order number" } } }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "account number" } } }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the project", "format": "uri" }, "projectId": { "type": "string", "description": "project id" } } }, "regulations": { "$ref": "#/components/schemas/Regulations" }, "assets": { "$ref": "#/components/schemas/Assets_a652916b" }, "change": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the IpBlockChange object", "format": "uri" } } }, "changeLog": { "required": [ "createdDateTime" ], "type": "object", "properties": { "createdDateTime": { "type": "string", "format": "date-time" }, "updatedDateTime": { "type": "string", "format": "date-time" }, "deletedDateTime": { "type": "string", "format": "date-time" } } }, "error": { "$ref": "#/components/schemas/ErrorsItem_425b1fcf" } }, "x-fastmcp-top-level-schema": "IpBlock" }, "Fabric_deleteStreamAssetByUuidResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Stream Asset URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "XF_PORT", "IP_VC", "EVPLAN_VC", "EVPL_VC", "XF_METRO", "XF_ROUTER", "ORGANIZATION", "PROJECT", "VIRTUAL_DEVICE", "DATA", "MGMT", "SSH", "FAB", "CTRL" ], "type": "string", "description": "Asset types" }, "metricsEnabled": { "type": "boolean", "description": "enable metric", "example": false }, "attachmentStatus": { "enum": [ "ATTACHING", "ATTACHED", "DETACHED", "DETACHING", "FAILED" ], "type": "string", "description": "asset status" } }, "description": "Stream object", "x-fastmcp-top-level-schema": "StreamAsset" }, "Fabric_getCloudEventByAssetIdResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_08f4c8d1" } }, "x-fastmcp-top-level-schema": "GetCloudEventsByAssetResponse" }, "Fabric_getCloudRouterActionsResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_42431b35" } }, "x-fastmcp-top-level-schema": "CloudRouterActionsSearchResponse" }, "Fabric_getConnectionRoutingProtocolsBgpActionByUuidResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Routing Protocol URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5/actions" }, "uuid": { "type": "string", "description": "Routing protocol identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "type": { "enum": [ "CLEAR_BGPIPV4", "CLEAR_BGPIPV6", "CLEAR_BGPIPV4_INBOUND", "CLEAR_BGPIPV6_INBOUND", "RESET_BGPIPV4", "RESET_BGPIPV6" ], "type": "string", "description": "BGP action type" }, "description": { "type": "string", "description": "BGP action description" }, "state": { "enum": [ "PENDING", "FAILED", "SUCCEEDED" ], "type": "string", "description": "BGP action state" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "x-fastmcp-top-level-schema": "BGPActionData" }, "Fabric_getConnectionStatsByPortUuidResult": { "type": "object", "properties": { "startDateTime": { "type": "string", "description": "Start and duration of the statistical analysis interval.", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "endDateTime": { "type": "string", "description": "End and duration of the statistical analysis interval.", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "viewPoint": { "enum": [ "aSide", "zSide" ], "type": "string", "description": "Point of view for connection metrics - aSide or zSide" }, "bandwidthUtilization": { "$ref": "#/components/schemas/BandwidthUtilization" } }, "description": "This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.", "x-fastmcp-top-level-schema": "Statistics" }, "Fabric_getCrossConnectActionByUuidResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Action URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4" }, "uuid": { "type": "string", "description": "Action Identifier.", "format": "uuid", "example": "30cc7878-54e3-4e1a-8651-87a61354bad4" }, "type": { "$ref": "#/components/schemas/Type_0116f717" }, "state": { "allOf": [ { "enum": [ "PENDING", "COMPLETED", "FAILED" ], "type": "string", "description": "Cross Connect Action State.", "example": "COMPLETED" } ] }, "data": { "$ref": "#/components/schemas/Data_f0a6c239" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_998bd88d" } }, "description": "Cross Connect Action Response.", "x-fastmcp-top-level-schema": "CrossConnectActionResponse" }, "Fabric_getLoaActionsByUuidResult": { "type": "object", "properties": { "href": { "type": "string", "description": "Action URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4" }, "uuid": { "type": "string", "description": "Action Identifier", "format": "uuid", "example": "30cc7878-54e3-4e1a-8651-87a61354bad4" }, "state": { "enum": [ "COMPLETED", "FAILED", "PENDING" ], "type": "string", "description": "Action State" }, "type": { "enum": [ "LOA_ISSUER_AUTHORIZATION", "LOA_REQUESTOR_ACCEPTANCE", "LOA_COPY_LINK", "LOA_SEND_EMAIL_NOTIFICATION", "LOA_CANCEL" ], "type": "string", "description": "Action to perform on the LOA.", "example": "LOA_ISSUER_AUTHORIZATION" }, "data": { "$ref": "#/components/schemas/Data_66916414" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_c32c50f9" } }, "description": "Action Response", "x-fastmcp-top-level-schema": "LoaActionResponse" }, "Fabric_getMetricByAssetIdResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_cc295fc2" } }, "x-fastmcp-top-level-schema": "GetMetricsByAssetResponse" }, "Fabric_getPortsResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_f8576704" } }, "description": "GET All User Port Across Fabric Metros", "x-fastmcp-top-level-schema": "AllPortsResponse" }, "Fabric_getServiceTokensResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data_09050040" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "description": "Service tokens authorize a user to access protected resources and services available on the Equinix Fabric network. The owner of the resources can distribute service tokens to third-party users (trusted partners and vendors), allowing them to directly access and work with the resources on the network without involving the resource owners.", "x-fastmcp-top-level-schema": "ServiceTokens" }, "Fabric_getTagsResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data_9dab13b8" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "description": "Equinix Fabric Tag List Response Object", "x-fastmcp-top-level-schema": "TagListResponse" }, "Fabric_listServiceProfilesResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data_aa931f6a" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "description": "Service Profiles", "x-fastmcp-top-level-schema": "ServiceProfiles" }, "Fabric_searchConnectionAdvertisedRoutesResult": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "data": { "$ref": "#/components/schemas/Data_5c274b7f" } }, "x-fastmcp-top-level-schema": "ConnectionRouteTableEntrySearchResponse" }, "Filter_0688d4ee": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/Property_59323f12" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "ServiceProfile-1" } } } }, "Filter_a9592b4b": { "type": "object", "properties": { "and": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "description": "Path to property" }, "operator": { "type": "string", "description": "Type of operation" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values for the given property" } } } } }, "description": "Filters" }, "Filter_a9830638": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/And_32083f06" } } }, "ForeignAccessPolicy": { "allOf": [ { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, {} ] }, "GeoZones": { "type": "array", "items": { "$ref": "#/components/schemas/GeoZonesItem" }, "description": "List of supported geographic zones of a Fabric Metro." }, "GeoZonesItem": { "type": "object", "properties": { "code": { "type": "string", "description": "Code assigned to a geographic zone." }, "name": { "type": "string", "description": "Name of a geographic zone." }, "description": { "type": "string", "description": "Description of a geographic zone." } }, "description": "Geographic zone of a Fabric Metro" }, "Grantee_7548b816": { "anyOf": [ { "$ref": "#/components/schemas/Grantee_b325aced" }, { "type": "string", "pattern": "^group:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}:_?[a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9]+)?:.{1,200}$", "description": "Globally unique string identifier for a group formatted like \"group:...\".", "example": "group:abc-123:idp:my-group" }, { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" } ], "description": "An entity that can be granted an access policy" }, "Grantee_b325aced": { "type": "string", "pattern": "^principal:([0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}:_?[a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9]+)?:.{1,200}|service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49})$", "description": "Globally unique string identifier for a principal formatted like \"principal:...\".", "example": "principal:abc-123:idp:example-user" }, "GroupMembershipClaim": { "type": "string", "maxLength": 100, "minLength": 2, "description": "Name of the claim in the ID tokens provided by this OIDC issuer whose value the STS should interpret as containing a user's group memberships, for authorization purposes. The value of the group membership claim in an ID token must be an array of strings, where each string is a unique, non-reassignable identifier for a group. When this property is not set, the STS does not interpret any claim from this provider as a group membership claim.", "example": "groups" }, "HierarchyNode": { "type": "object", "properties": { "levelType": { "enum": [ "ibx", "zone", "cage", "cabinet", "sensor" ], "type": "string", "description": "levelType indicates which level in the location hierarchy does the node belong to.", "example": "ibx" }, "levelValue": { "type": "string", "description": "ibx code, zone us id, cage us id, cabinet us id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.", "example": "SV5" }, "label": { "type": "string", "description": "ibx code, zone unique space id, cage unique space id, cabinet unique space id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.", "example": "SV5" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/HierarchyNode" } } } }, "Hops": { "type": "array", "items": { "$ref": "#/components/schemas/HopsItem" } }, "HopsItem": { "type": "object", "properties": { "hop": { "type": "integer", "example": 1 }, "probes": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "dns.google" }, "ip": { "type": "string", "example": "8.8.8.8" }, "asn": { "type": "integer", "example": 15169 }, "rtt": { "type": "string", "example": 11.764 }, "annotation": { "type": "string" } } } } } }, "HostNamePrefix": { "type": "string", "description": "Host name prefix for identification. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14 characters; Aruba 2-24 characters.", "example": "mySR" }, "Humidity_a99084b4": { "required": [ "unit", "value" ], "type": "object", "properties": { "value": { "type": "number", "description": "Specific value, to be read together with unit.", "example": 33.3 }, "unit": { "type": "string", "description": "Unit for value.", "example": "CELSIUS" } }, "description": "Single value with related unit (e.g. percentage for humidity or Celsius degree for temperature)." }, "Humidity_c93621ed": { "allOf": [ { "$ref": "#/components/schemas/Humidity_a99084b4" } ], "description": "Sensor reading - humidity" }, "IBX_Location": { "title": "IBX Location", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "maxLength": 10, "minLength": 1, "type": "string", "example": "AM1" }, "cages": { "$ref": "#/components/schemas/Cages" } }, "description": "IBX, Cage, Accounts and Cabinet information" }, "IbxLocation": { "title": "ibxLocation", "required": [ "ibx", "cages" ], "type": "object", "properties": { "ibx": { "maxLength": 10, "minLength": 1, "type": "string" }, "cages": { "minItems": 1, "type": "array", "items": { "required": [ "cage", "accountNumber" ], "type": "object", "properties": { "cage": { "minLength": 1, "type": "string" }, "accountNumber": { "type": "string" } } } } }, "example": { "ibx": "PA2", "cages": [ { "cage": "PA2:02:002MC1" } ] } }, "IbxLocationCondition": { "properties": { "metroCodes": { "items": { "type": "string", "pattern": "^[A-Z]{2}$", "description": "A two-letter code identifying an Equinix metro area (e.g. SV for Silicon Valley).", "example": "SV" }, "type": "array", "maxItems": 50, "minItems": 1, "uniqueItems": true }, "ibxIds": { "items": { "type": "string", "pattern": "^[A-Z]{2}[0-9A-Z]{1,5}x?$", "description": "Identifies an IBX data center location (e.g. SV1).", "example": "SV1" }, "type": "array", "maxItems": 50, "minItems": 1, "uniqueItems": true }, "cageIds": { "items": { "type": "string", "pattern": "^[A-Z]{2}[0-9A-Z]{1,5}x?:[a-zA-Z0-9:_.-]{1,50}$", "description": "Identifies an Equinix colocation cage within an IBX (e.g. SV1:cage-1).", "example": "SV1:cage-1" }, "type": "array", "maxItems": 50, "minItems": 1, "uniqueItems": true } }, "additionalProperties": false, "type": "object", "description": "A condition that limits permissible actions according to location, by Metro, IBX, or cage.\n The values supplied in this condition are OR'd together: matching any one supplied attribute\n is sufficient to allow the action.\n\n Each condition is compared with the action's attribute; if the action doesn't\n provide a value, the condition is compared with the target resource's attribute.\n If neither source provides the attribute, that condition contributes no restriction.\n\n Location values that broadly cover more specific ones are not accepted. For example:\n - If metroCodes contains 'NY', then ibxIds must not contain 'NY5'\n (since NY already includes all IBXs in New York)\n - If ibxIds contains 'NY5', then cageIds must not contain 'NY5:ABC123'\n (since NY5 already includes all cages in that IBX)" }, "IbxNotificationSummary": { "title": "IbxNotificationSummary", "required": [ "id", "type", "startTimestamp", "ibxs", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Notification Identification.", "example": "5-122719992195" }, "type": { "enum": [ "IBX_MAINTENANCE", "IBX_INCIDENT", "IBX_ADVISORY", "IBX_SMARTVIEW" ], "type": "string", "description": "Notification Type", "example": "IBX_ADVISORY" }, "startTimestamp": { "type": "string", "description": "Event/Notification start date.", "format": "date-time", "example": "2018-01-28T03:46:36.720Z" }, "endTimestamp": { "type": "string", "description": "Event/Notification start date", "format": "date-time", "example": "2018-01-29T03:46:36.720Z" }, "ibxs": { "type": "array", "items": { "type": "string" }, "description": "List of IBX", "example": [ "SG1", "CH2" ] }, "status": { "enum": [ "EXTENDED", "RESCHEDULED", "CANCELLED", "COMPLETED", "IN_PROGRESS", "RESOLVED", "UPDATED", "NEW", "OTHER" ], "type": "string", "description": "Event/Notification Status.", "example": "RESOLVED" }, "summary": { "type": "string", "description": "Summary information about the event / notification.", "example": "Fire Alarm - IBX was Evacuated" } }, "description": "Summary of IBX Notification without email details." }, "InboundRulesItem": { "type": "object", "properties": { "protocol": { "type": "string", "description": "Protocol.", "example": "TCP" }, "srcPort": { "type": "string", "description": "Source port.", "example": "53" }, "dstPort": { "type": "string", "description": "Destination port.", "example": "any" }, "subnet": { "type": "string", "description": "An array of subnets.", "example": "192.168.1.1/32" }, "seqNo": { "type": "integer", "description": "The sequence number of the inbound rule.", "example": 1 }, "description": { "type": "string", "description": "Description of the inboundRule.", "example": "My Rule 1" } } }, "InboundRules_2b9969ef": { "type": "array", "items": { "$ref": "#/components/schemas/InboundRulesItem" }, "description": "An array of inbound rules." }, "InboundRules_8fddabb6": { "type": "array", "items": { "$ref": "#/components/schemas/InboundRulesItem" }, "description": "An array of inbound rules" }, "Inbound_13f2d2f3": { "type": "object", "properties": { "max": { "type": "number", "description": "Max bandwidth within request time range, represented in units specified by response \"units\" field", "format": "float" }, "mean": { "type": "number", "description": "Mean bandwidth within request time range, represented in units specified by response \"units\" field", "format": "float" }, "metrics": { "$ref": "#/components/schemas/Metrics_84103b98" } }, "description": "Directional statistics" }, "Inbound_69c91658": { "type": "object", "properties": { "max": { "type": "number", "description": "Max throughput during the time interval.", "example": 29.90603462474768 }, "mean": { "type": "number", "description": "Mean throughput during the time interval.", "example": 6.341387726453309 }, "lastPolled": { "type": "number", "description": "The throughput of the last polled data.", "example": 4.2551751570268115 }, "metrics": { "$ref": "#/components/schemas/Metrics_c12f7323" } }, "description": "Interface traffic statistics" }, "Include": { "maxItems": 8, "type": "array", "items": { "$ref": "#/components/schemas/IncludeItem" } }, "IncludeItem": { "type": "string", "description": "Supported event or metric types to use on event and metric selectors:\n * `*` - all events or metrics\n * `equinix.fabric.company_profile.*` - company profile events\n * `equinix.fabric.connection.*` - connection events, metrics, or alerts\n * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events\n * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events\n * `equinix.fabric.connection_maintenance.*` - connection maintenance events\n * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events\n * `equinix.fabric.connection_route_filter.*` - connection route filter events\n * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events\n * `equinix.fabric.internet_access.*` - internet access service events\n * `equinix.fabric.ip_block.*` - IP block events\n * `equinix.fabric.metric` - metric collection events\n * `equinix.fabric.metro.*` - metro metrics or alerts\n * `equinix.fabric.network.*` - network events\n * `equinix.fabric.physical_port.*` - physical port events\n * `equinix.fabric.port.*` - virtual port events, metrics, or alerts\n * `equinix.fabric.port_maintenance.*` - port maintenance events\n * `equinix.fabric.route_aggregation.*` - route aggregation events\n * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events\n * `equinix.fabric.route_filter.*` - route filter events\n * `equinix.fabric.route_filter_rule.*` - route filter rule events\n * `equinix.fabric.router.*` - cloud router events or alerts\n * `equinix.fabric.router_action.*` - cloud router action events\n * `equinix.fabric.router_command.*` - cloud router command events\n * `equinix.fabric.routing_protocol_action.*` - routing protocol action events\n * `equinix.fabric.service_profile_connection.*` - service profile connection events\n * `equinix.fabric.service_token.*` - service token events\n * `equinix.fabric.time_service.*` - precision time service events\n * `equinix.network.maintenance.*` - network maintenance events\n * `equinix.network.repair.*` - network repair events\n * `equinix.network_edge.*` - network edge events, metrics, or alerts\n * `equinix.network_edge.acl.*` - network edge acl events\n * `equinix.network_edge.device.*` - network edge device events\n * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts\n * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events\n * `equinix.access_manager.*` - identity access manager events\n * `equinix.access_manager.user.role.*` - identity access manager user role events\n * `equinix.iam.principal.*` - IAM principal authorization and token events\n * `equinix.identity.user.*` - identity user events\n * `equinix.identity.organization.*` - identity organization membership events\n * `equinix.resource_manager.organization.*` - resource manager organization events\n * `equinix.resource_manager.project.*` - resource manager project events\n", "example": "equinix.fabric.connection.*" }, "InlinePermission": { "properties": { "resources": { "$ref": "#/components/schemas/Resources_31826c88" }, "serviceActions": { "$ref": "#/components/schemas/ServiceActions_393383e5" }, "condition": { "type": "string", "example": "context.myAttribute < 5" }, "ibxLocationCondition": { "$ref": "#/components/schemas/IbxLocationCondition" } }, "additionalProperties": false, "type": "object", "required": [ "resources", "serviceActions" ], "description": "The PermissionSet defined by crossing the named resources with the named actions.", "title": "InlinePermission" }, "Interface_3d0e58e1": { "type": "object", "properties": { "type": { "enum": [ "NETWORK" ], "type": "string", "description": "Type of interface" }, "id": { "type": "integer", "description": "Network Edge assigned identifier" }, "uuid": { "type": "string", "description": "Interface identifier", "format": "uuid" } }, "description": "Virtual Device Interface Information" }, "Interface_ddd240fb": { "type": "object", "properties": { "href": { "type": "string", "description": "Interface URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned Interface identifier", "format": "uuid" }, "id": { "type": "integer", "description": "Interface id" }, "type": { "enum": [ "CLOUD", "NETWORK" ], "type": "string", "description": "Interface type" }, "projectId": { "type": "string", "description": "Interface Project ID" } }, "description": "Interface Information" }, "Interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/InterfacesItem" } }, "InterfacesItem": { "type": "object", "properties": { "id": { "type": "number", "description": "Interface ID.", "example": 1.0 }, "name": { "type": "string", "description": "Interface name.", "example": "ethernet1" }, "status": { "enum": [ "ASSIGNED", "AVAILABLE", "RESERVED" ], "type": "string", "description": "Interface status", "example": "ASSIGNED" }, "operationStatus": { "enum": [ "UP", "DOWN" ], "type": "string", "description": "Interface operational status", "example": "DOWN" }, "macAddress": { "type": "string", "description": "MAC address.", "example": "fa16.3e1c.a8d8" }, "ipAddress": { "type": "string", "description": "IP address.", "example": "2.2.2.2" }, "assignedType": { "enum": [ "EQUINIX_MANAGED", "USER_MANAGED" ], "type": "string", "description": "Assigned type", "example": "EQUINIX_MANAGED" }, "type": { "enum": [ "DATA", "MGMT", "WAN" ], "type": "string", "description": "The type of interface (e.g., DATA, MGMT, WAN)", "example": "DATA" } }, "description": "Basic interface information" }, "Internetaccess_createEquinixInternetAccessResult": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Result_1fb444d6" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true }, "Internetaccessv2_getEquinixInternetAccessServiceDetailsResult": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/Result_409dbcda" } }, "required": [ "result" ], "x-fastmcp-wrap-result": true }, "Intersect": { "allOf": [ {}, { "$ref": "#/components/schemas/Permissions_0c73f7d1" } ], "description": "Entries must appear in both the `intersect` field and the `permissions` to be in the\n results from this permission object." }, "Invoice": { "title": "Invoice", "required": [ "invoiceId", "date", "amount", "status" ], "type": "object", "properties": { "invoiceId": { "minLength": 1, "type": "string", "description": "Identifier for the invoice" }, "transactionNumber": { "minLength": 1, "type": "string", "description": "Tansaction number of the invoice" }, "amount": { "type": "number", "description": "Total amount of the invoice", "format": "double" }, "date": { "type": "string", "description": "Date of the invoice", "format": "date" }, "type": { "title": "InvoiceType", "enum": [ "INVOICE", "MANUAL_INVOICE", "CREDIT_MEMO", "STATEMENT" ], "type": "string", "description": "Type of the invoice" }, "documents": { "$ref": "#/components/schemas/Documents" } }, "example": { "invoiceId": "123435", "transactionNumber": "654321879", "amount": 914526.87, "date": "2017-03-23", "type": "CREDIT_MEMO", "documents": [ { "documentId": "64322", "fileType": "EXCEL_DETAILS", "type": "STATEMENT" }, { "documentId": "213324", "fileType": "EXCEL_DETAILS", "type": "INVOICE" }, { "documentId": "44353", "fileType": "PDF_DETAILS", "type": "STATEMENT" }, { "documentId": "233424", "fileType": "EXCEL_SUMMARY", "type": "MANUAL_INVOICE" } ] } }, "InvoiceDocument": { "title": "InvoiceDocument", "required": [ "documentId", "fileType", "type" ], "type": "object", "properties": { "documentId": { "type": "string", "description": "Unique Identifier for the document" }, "fileType": { "enum": [ "PDF_DETAILS", "EXCEL_DETAILS", "PDF_SUMMARY", "EXCEL_SUMMARY", "INVOICE_PDF", "BOLETO_PDF", "NF_URL" ], "type": "string", "description": "File type of the document" }, "type": { "title": "InvoiceType", "enum": [ "INVOICE", "MANUAL_INVOICE", "CREDIT_MEMO", "STATEMENT" ], "type": "string", "description": "Type of the invoice" } }, "example": { "documentId": "DETAILED_PDF_EN", "fileType": "PDF_DETAILS", "type": "STATEMENT" } }, "Invoices": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" }, "description": "Available invoices for the account" }, "IpBlock_083ee67b": { "allOf": [ { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } }, { "$ref": "#/components/schemas/IpBlock_23506eb1" } ] }, "IpBlock_23506eb1": { "required": [ "prefixLength" ], "type": "object", "properties": { "prefixLength": { "maximum": 30.0, "minimum": 24.0, "type": "integer", "description": "Length of the IP block, number after the / (slash)" }, "addressingPlans": { "$ref": "#/components/schemas/AddressingPlans" }, "questions": { "$ref": "#/components/schemas/Questions_ad0e0bd4" } } }, "IpBlock_8102651f": { "allOf": [ { "$ref": "#/components/schemas/IpBlock_f7a51638" }, { "$ref": "#/components/schemas/IpBlock_b39f39e0" } ] }, "IpBlock_9befaff9": { "allOf": [ { "$ref": "#/components/schemas/IpBlock_f7a51638" }, { "$ref": "#/components/schemas/IpBlock_9ecb6ea8" } ] }, "IpBlock_9ecb6ea8": { "type": "object", "properties": { "prefix": { "$ref": "#/components/schemas/Prefix_bc7323fe" }, "prefixLength": { "maximum": 128.0, "minimum": 1.0, "type": "integer", "description": "Determines the size of ip subnet", "example": 64 } } }, "IpBlock_a884a7c2": { "required": [ "prefixLength" ], "type": "object", "properties": { "prefixLength": { "$ref": "#/components/schemas/PrefixLength" } } }, "IpBlock_b39f39e0": { "type": "object", "properties": { "prefix": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:/[0-2]*\\d{1}|/3[0-2]){1}$", "type": "string", "description": "Subnet prefix", "example": "198.51.100.0/24" }, "prefixLength": { "maximum": 32.0, "minimum": 1.0, "type": "integer", "description": "Determines the size of ip subnet", "example": 30 }, "addressingPlans": { "$ref": "#/components/schemas/AddressingPlans" }, "questions": { "$ref": "#/components/schemas/Questions_17431273" } } }, "IpBlock_f7a51638": { "required": [ "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "Ip block URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/ipBlocks/71a1eb68-4daf-4ef0-bd7f-6970727b6fe8" }, "uuid": { "type": "string", "format": "uuid", "example": "71a1eb68-4daf-4ef0-bd7f-6970727b6fe8" }, "type": { "enum": [ "IA_IP_BLOCK" ], "type": "string", "description": "Determines the type of Routing Protocol", "example": "IA_IP_BLOCK" } } }, "Ipv4_49af3f34": { "type": "object", "properties": { "customerRoute": { "type": "object", "properties": { "importPolicy": { "enum": [ "PI", "PA" ], "type": "string", "example": "PA" } } }, "peering": { "type": "object", "properties": { "vrrpEnabled": { "type": "boolean", "example": true }, "peerSubnet": { "type": "object", "properties": { "prefixLength": { "type": "integer", "example": 30 }, "quantity": { "type": "integer" } } } } } } }, "Ipv4_5ecf1ff9": { "required": [ "customerRoutes", "peerings" ], "type": "object", "properties": { "customerRoutes": { "$ref": "#/components/schemas/CustomerRoutes_cb50380e" }, "peerings": { "$ref": "#/components/schemas/Peerings_72fc3c98" } } }, "Ipv4_a0473817": { "required": [ "customerRoutes" ], "type": "object", "properties": { "customerRoutes": { "$ref": "#/components/schemas/CustomerRoutes_6a006ab5" } } }, "Ipv4_a83cf05c": { "required": [ "customerRoute" ], "type": "object", "properties": { "customerRoute": { "$ref": "#/components/schemas/CustomerRoute" } } }, "Ipv4_b8d452c8": { "title": "ipv4", "required": [ "primary", "secondary", "networkMask" ], "type": "object", "properties": { "primary": { "type": "string", "description": "Primary Timing Server IP Address", "format": "ipv4" }, "secondary": { "type": "string", "description": "Secondary Timing Server IP Address", "format": "ipv4" }, "networkMask": { "type": "string", "description": "Network Mask", "format": "ipv4" }, "defaultGateway": { "type": "string", "description": "Gateway Interface IP address", "format": "ipv4" } }, "description": "EPT service network information", "example": { "primary": "10.0.0.1", "secondary": "10.0.0.2", "networkMask": "255.255.255.240", "defaultGateway": "10.0.0.3" } }, "Ipv4_c1a253f3": { "required": [ "customerRoutes", "peerings" ], "type": "object", "properties": { "customerRoutes": { "$ref": "#/components/schemas/CustomerRoutes_9e613813" }, "peerings": { "$ref": "#/components/schemas/Peerings_1ee60942" } } }, "Ipv6_25b12f91": { "required": [ "customerRoutes", "peerings" ], "type": "object", "properties": { "customerRoutes": { "$ref": "#/components/schemas/CustomerRoutes_63d0810d" }, "peerings": { "$ref": "#/components/schemas/Peerings_6d1b52c8" } } }, "Ipv6_41dd5021": { "required": [ "customerRoutes" ], "type": "object", "properties": { "customerRoutes": { "$ref": "#/components/schemas/CustomerRoutes_77dd959b" } } }, "Ipv6_f5b325b1": { "required": [ "customerRoutes", "peerings" ], "type": "object", "properties": { "customerRoutes": { "$ref": "#/components/schemas/CustomerRoutes_99fdcee7" }, "peerings": { "$ref": "#/components/schemas/Peerings_5d51f951" } } }, "Issuer": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address of the issuer contact.", "format": "email", "example": "user@org1.com" }, "orgId": { "type": "integer", "description": "Organization ID of the issuer.", "example": 9257 }, "orgName": { "type": "string", "description": "Organization name of the issuer.", "example": "ABC Inc." } }, "description": "Issuer" }, "Jwks": { "properties": { "keys": { "items": { "properties": {}, "type": "object" }, "type": "array" } }, "additionalProperties": false, "type": "object", "required": [ "keys" ], "description": "TEMPORARY: In the future, the STS will retrieve the provider's JWKS via standard OIDC Discovery mechanisms, and this will not be an input parameter!." }, "Key": { "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string", "description": "The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.", "format": "byte" }, "KeyDetails": { "type": "object", "properties": { "value": { "type": "string", "description": "Provider Encoded activation key", "example": "key_here" }, "providerId": { "type": "string", "description": "AWS Connection identifier" }, "accountId": { "type": "string", "description": "Account identifier" }, "bandwidth": { "type": "integer", "description": "Bandwidth in Mbps" }, "region": { "type": "string", "description": "Cloud provider region identifier" } }, "description": "Activation Key Details Beta" }, "LastMileConfig": { "type": "object", "properties": { "apiIntegration": { "$ref": "#/components/schemas/ApiIntegration" }, "productCatalogs": { "$ref": "#/components/schemas/ProductCatalogs" } }, "description": "Last-mile provider catalogs and offerings available for this service profile.", "example": [ { "apiIntegration": { "siteValidationEnabled": true, "dataCenterLocationEnabled": false, "productOfferingEnabled": false, "poqEnabled": true, "quoteEnabled": true, "placeOrderEnabled": false, "quoteViaAggregatorEnabled": false }, "contactInfo": [ { "type": "SUPPORT_URL", "url": "http://www.example.com/lastmile/home" }, { "type": "DOCUMENTATION_URL", "url": "http://www.example.com/lastmile/home" }, { "type": "SUPPORT_EMAIL", "emails": [ "support@example.com" ] } ], "productCatalogs": [ { "name": "att fiber", "webUrl": "att.com/lastmile", "deliveryDate": { "unit": "DAYS", "min": 1, "max": 10 }, "billingTerms": [ 1, 12, 24, 36, 48, 60 ], "offerings": [ { "bandwidth": 10, "price": { "unit": "USD", "min": 10, "max": 100 } }, { "bandwidth": 50, "price": { "unit": "USD", "min": 50, "max": 500 } } ] }, { "name": "att fiber gold", "webUrl": "att.com/wireless", "deliveryDate": { "unit": "DAYS", "min": 1, "max": 5 }, "billingTerms": [ 1, 12, 24, 36, 48, 60 ], "offerings": [ { "bandwidth": 10, "price": { "unit": "USD", "min": 10, "max": 100 } }, { "bandwidth": 50, "price": { "unit": "USD", "min": 50, "max": 500 } } ] } ] } ] }, "LastRev": { "type": "string", "maxLength": 256, "minLength": 1, "description": "An opaque string that represents the expected revision of a given resource. This is provided when a resource is\n updated so that if a concurrent update has occurred since the resource was read, then the collision will be detected.", "example": "abc123" }, "Level": { "maxItems": 3, "minItems": 1, "uniqueItems": true, "type": "array", "items": { "enum": [ "ZONE", "IBX", "CAGE" ], "type": "string" }, "description": "This field is not required. If not provided in the request, subscription will include all environmental messages at the IBX, zone, and cage levels. If granularity is specified, at least one level must be provided." }, "LicenseFileId": { "type": "string", "description": "For Juniper devices you need to provide a licenseFileId if you want to BYOL (Bring Your Own License). You get a licenseFileId when you upload a license file by calling license upload API (Upload a license file before creating a virtual device). For Cisco devices, you do not need to provide a licenseFileId at the time of device creation. Once the device is provisioned, you can get the deviceSerialNo by calling Get virtual device {uuid} API. With the deviceSerialNo you can generate a license file on Cisco site. Afterward, you can upload the license file by calling license upload API (Upload a license file after creating a virtual device).", "example": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc" }, "LinkDevicesItem_83b08f29": { "required": [ "deviceUuid" ], "type": "object", "properties": { "asn": { "type": "integer", "description": "The ASN number of the device. The request will fail if you provide a new ASN for a device that already has an ASN.", "format": "int64", "example": 25658 }, "deviceUuid": { "type": "string", "description": "device", "example": "70754e55-a064-40c3-a911-6dc1f14b96fd" }, "interfaceId": { "type": "integer", "description": "Any available interface of the device.", "example": 6 } }, "description": "Unique Id of a device." }, "LinkDevicesItem_a419dcd7": { "type": "object", "properties": { "deviceUuid": { "type": "string", "description": "A device that is part of the device linked group", "example": "8ea5a0e4-2bf7-45c2-9aa7-e846a8cd5561" }, "deviceName": { "type": "string", "description": "Device name", "example": "Cisco Router1" }, "metroCode": { "type": "string", "description": "Metro Code", "example": "DA" }, "metroName": { "type": "string", "description": "Name of the metro.", "example": "Dallas" }, "deviceTypeCode": { "$ref": "#/components/schemas/DeviceTypeCode" }, "category": { "enum": [ "ROUTER", "FIREWALL", "SDWAN" ], "type": "string", "description": "Device category", "example": "ROUTER" }, "ipAssigned": { "type": "string", "description": "Assigned IP address", "example": "10.0.0.2/27" }, "interfaceId": { "type": "integer", "description": "Interface ID", "example": 6 }, "status": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONED", "DEPROVISIONING", "FAILED" ], "type": "string", "description": "The status of the device", "example": "PROVISIONING" }, "deviceManagementType": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string", "description": "Device management type", "example": "EQUINIX-CONFIGURED" }, "networkScope": { "type": "string", "description": "Network scope", "example": "TENANT" }, "isDeviceAccessible": { "type": "boolean", "description": "Whether the device is accessible", "example": true } } }, "LinkDevices_21e67921": { "type": "array", "items": { "$ref": "#/components/schemas/LinkDevicesItem_83b08f29" }, "description": "An array of devices to link.", "example": [ { "deviceUuid": "9ea5a0e4-2bf7-45c2-9aa7-e846a8cd5560", "asn": 1007, "interfaceId": 7 }, { "deviceUuid": "8ea5a0e4-2bf7-45c2-9aa7-e846a8cd5561", "asn": 2006, "interfaceId": 6 } ] }, "LinkDevices_e04b20a5": { "type": "array", "items": { "$ref": "#/components/schemas/LinkDevicesItem_a419dcd7" }, "description": "An array of metros and the devices in the metros belonging to the group.", "example": [ { "deviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b", "deviceName": "Cisco Router1", "metroCode": "DA", "metroName": "Dallas", "deviceTypeCode": "C8000V", "category": "ROUTER", "ipAssigned": "10.0.0.0/27", "interfaceId": 5, "status": "PROVISIONING", "deviceManagementType": "SELF-CONFIGURED", "networkScope": "TENANT", "isDeviceAccessible": true }, { "deviceUuid": "5cfb5675-5c3f-4275-adba-0c9e3c26c96c", "deviceName": "Cisco Router2", "metroCode": "DA", "metroName": "Dallas", "deviceTypeCode": "C8000V", "category": "ROUTER", "ipAssigned": "10.0.0.0/27", "interfaceId": 5, "status": "PROVISIONING", "deviceManagementType": "SELF-CONFIGURED", "networkScope": "TENANT", "isDeviceAccessible": true } ] }, "LinkProtocol": { "type": "object", "properties": { "type": { "enum": [ "UNTAGGED", "DOT1Q", "QINQ", "EVPN_VXLAN", "VXLAN" ], "type": "string", "description": "Type of Link Protocol" }, "vlanTag": { "maximum": 4092.0, "minimum": 2.0, "type": "integer", "description": "vlanTag value specified for DOT1Q connections" }, "vlanSTag": { "maximum": 4092.0, "minimum": 2.0, "type": "integer", "description": "vlanSTag value specified for QINQ connections" }, "vlanCTag": { "maximum": 4092.0, "minimum": 2.0, "type": "integer", "description": "vlanCTag value specified for QINQ connections" } }, "description": "Connection link protocol Configuration" }, "LinkProtocolConfig": { "type": "object", "properties": { "encapsulationStrategy": { "enum": [ "CTAGED", "BOTH", "NAMED" ], "type": "string", "description": "was tagType - missing on wiki" }, "namedTags": { "maxItems": 64, "type": "array", "items": { "type": "string" } }, "vlanCTagLabel": { "type": "string", "description": "was ctagLabel" }, "reuseVlanSTag": { "type": "boolean", "default": false, "example": true }, "encapsulation": { "enum": [ "QINQ", "DOT1Q", "UNTAGGED" ], "type": "string", "description": "Port encapsulation - Derived response attribute. Ignored on request payloads." } }, "description": "Configuration for dot1q to qinq translation support" }, "LinksItem_028460fc": { "type": "object", "allOf": [ { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, { "properties": { "rel": { "type": "string", "description": "self, info, update, delete, statistics, events" }, "method": { "type": "string" }, "authenticate": { "type": "boolean", "default": false }, "contentType": { "type": "string", "example": "application/json" } } } ] }, "LinksItem_65f4f1d3": { "required": [ "href", "rel" ], "type": "object", "properties": { "rel": { "enum": [ "self", "info", "update", "delete", "statistics", "events" ], "type": "string", "description": "Attribute describing the relationship ('rel') of the linked resource to its associated document.", "example": "info" }, "href": { "type": "string", "description": "An absolute URL that is the subject of the link's context, such as a link to a service profile or set of statistics.", "example": "diloa/v1/digitalLoas/{resource-path}" }, "method": { "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH" ], "type": "string", "description": "HTTP method used in the API call to request the specified resource.", "example": "GET" }, "contentType": { "type": "string", "description": "MIME type indicating the document format. Syntax complies with IETF RFC 6838.", "example": "application/json" }, "authenticate": { "type": "boolean", "description": "Flag showing whether authentication is required to access the linked resource. The default value is false.", "example": true } }, "description": "An element describing the current document's relationship to a designated external resource." }, "LinksItem_c2002346": { "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri" }, "rel": { "type": "string", "description": "OperationId from Swagger hub spec" }, "method": { "type": "string", "description": "Http method type" }, "contentType": { "type": "string", "description": "Content type for the response" }, "authenticate": { "type": "boolean", "description": "Authentication required or not" } } }, "LinksItem_fc01fec2": { "type": "object", "properties": { "href": { "type": "string", "description": "Sub-resource URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules" }, "rel": { "type": "string", "description": "Operation identifier of the linked sub-resource.", "example": "getCrossConnectSchedulesByUuid" }, "method": { "type": "string", "description": "HTTP method to use on the sub-resource.", "example": "GET" }, "contentType": { "type": "string", "description": "Content type returned by the sub-resource.", "example": "application/json" }, "authenticate": { "type": "boolean", "description": "Whether authentication is required.", "example": true } }, "description": "Link to a Cross Connect sub-resource." }, "Links_3706c0c8": { "type": "array", "items": { "$ref": "#/components/schemas/LinksItem_c2002346" }, "description": "Network sub-resources links" }, "Links_459c701e": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/LinksItem_65f4f1d3" }, "description": "HATEOAS links specifying possible follow-up interactions." }, "Links_4fb063ac": { "title": "Links", "required": [ "self" ], "type": "object", "properties": { "prev": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/reports?limit=10" } }, "self": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/reports?limit=10" } }, "next": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "minLength": 1, "type": "string", "description": "href of the link" } }, "example": { "href": "/reports?limit=10" } } }, "example": { "prev": { "href": "/reports?limit=10&offset=50" }, "self": { "href": "/reports?limit=10&offset=40" }, "next": { "href": "/reports?limit=10&offset=30" } } }, "Links_8561166d": { "type": "array", "items": { "$ref": "#/components/schemas/LinksItem_028460fc" } }, "Links_b5ec80bd": { "type": "array", "items": { "$ref": "#/components/schemas/LinksItem_fc01fec2" }, "description": "Links to the Cross Connect sub-resources - schedules, services, notes and attachments.\n" }, "List": { "items": { "$ref": "#/components/schemas/ListItem" }, "type": "array" }, "ListItem": { "properties": { "roleId": { "type": "string", "pattern": "^role:[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$", "description": "Immutable UUID of this Role", "example": "role:550e8400-e29b-41d4-a716-446655440000" }, "name": { "type": "string", "example": "Network Admin" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assignmentScopeTypes": { "$ref": "#/components/schemas/AssignmentScopeTypes" }, "permissions": { "$ref": "#/components/schemas/Permissions_9d45b317" } }, "additionalProperties": false, "type": "object", "required": [ "roleId", "name", "description", "assignmentScopeTypes", "permissions" ], "description": "A named set of Role Actions that can be granted to a principal." }, "Loa_22cb5cff": { "allOf": [ { "$ref": "#/components/schemas/Loa_bcb2e03a" } ], "description": "Required for a Cross Connect with LOA and when bmmrType is EQUINIX." }, "Loa_bcb2e03a": { "type": "object", "properties": { "href": { "type": "string", "description": "LOA URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/loas/c61f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "LOA Identifier - Attachment UUID or LOA UUID.", "format": "uuid", "example": "c61f485e-3094-42de-8797-0ef19a51df79" } }, "description": "LOA Reference for Cross Connect. Provide either uuid or digitalLoaId.\n" }, "Location_32724e48": { "required": [ "metroCode" ], "type": "object", "properties": { "metroHref": { "type": "string", "description": "The Canonical URL at which the resource resides.", "example": "https://api.equinix.com/fabric/v4/metros/AM" }, "region": { "type": "string", "example": "AMER, APAC, EMEA" }, "metroName": { "type": "string", "example": "Amsterdam" }, "metroCode": { "type": "string", "example": "AM" } } }, "Location_53f78db6": { "type": "object", "properties": { "metroHref": { "type": "string", "example": "https://api.equinix.com/fabric/v4/metros/AM" }, "region": { "type": "string", "example": "AMER, APAC, EMEA" }, "metroName": { "type": "string", "example": "Amsterdam" }, "metroCode": { "type": "string", "example": "AM" }, "ibx": { "type": "string", "example": "AM1" } } }, "Location_ed4243bb": { "required": [ "href", "metroCode", "metroName", "region" ], "type": "object", "properties": { "href": { "type": "string", "description": "Location URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/ibxs/SV1" }, "region": { "enum": [ "AMER", "EMEA", "APAC" ], "type": "string", "description": "AMER (the Americas),\nAPAC (Asia-Pacific),\nEMEA (Europe, the Middle East, and Africa)\n", "example": "AMER" }, "metroName": { "type": "string", "description": "Name of the city in which a specified Equinix asset is located.", "example": "Silicon Valley" }, "metroCode": { "type": "string", "description": "Two-letter prefix indicating the metropolitan area in which a specified Equinix asset is located.\n", "example": "SV" }, "ibx": { "type": "string", "description": "Alphanumeric identifier assigned to an Equinix International Business Exchange (IBX)\ndata center in which a specified asset is located.\n", "example": "SV1" } } }, "Location_f0aa0dcf": { "required": [ "address", "countryCode", "ibx", "metroCode", "metroName", "region" ], "type": "object", "properties": { "ibx": { "type": "string", "description": "IBX data center identifier.", "example": "TY1" }, "region": { "enum": [ "AMER", "APAC", "EMEA" ], "type": "string", "description": "Region", "example": "EMEA" }, "metroName": { "type": "string", "description": "Metropolitan area name.", "example": "Amsterdam" }, "metroCode": { "type": "string", "description": "Metropolitan area identifier.", "example": "AM" }, "countryCode": { "type": "string", "description": "Country code.", "example": "NL" }, "address": { "type": "string", "description": "IBX data center address information.", "example": "8 Buckingham Avenue, Slough Trading Estate, SL1 4AX Slough, England" } }, "description": "Location" }, "LocationsItem_07ccc9d1": { "required": [ "metroHref", "metroCode", "ibx", "region" ], "type": "object", "properties": { "metroHref": { "type": "string", "description": "Metro URL path for the linked resource", "format": "uri", "example": "https://api.equinix.com/fabric/v4/metros/WA" }, "metroCode": { "pattern": "^[A-Z]{2}$", "type": "string", "description": "Code representing the metro", "example": "WA" }, "region": { "enum": [ "APAC", "EMEA", "AMER" ], "type": "string", "description": "Geographic region", "example": "EMEA" }, "ibx": { "type": "string", "description": "IBX data center code", "example": "WA1" } } }, "LocationsItem_c2a148b9": { "required": [ "ibxCode", "metroCode", "region" ], "type": "object", "properties": { "metroCode": { "pattern": "^[A-Z]{2,2}$", "type": "string", "example": "WA" }, "ibxCode": { "type": "string", "description": "IBX data center code", "format": "^[A-Z]{2,2}[0-9]+X?$", "example": "WA1" }, "region": { "enum": [ "APAC", "EMEA", "AMER" ], "type": "string", "example": "APAC" } } }, "Locations_8741feda": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/LocationsItem_c2a148b9" } }, "Locations_cc851082": { "type": "array", "items": { "$ref": "#/components/schemas/LocationsItem_07ccc9d1" }, "description": "List of locations associated with the service" }, "ManagedPermissionSets": { "anyOf": [ { "type": "string", "enum": [ "none" ] }, { "items": { "type": "string", "pattern": "^managedset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed permission set globally.", "example": "managedset:my-set" }, "type": "array", "maxItems": 50, "minItems": 1, "uniqueItems": true } ] }, "ManagedPolicies": { "anyOf": [ { "type": "string", "enum": [ "none" ] }, { "items": { "type": "string", "pattern": "^managedpolicy:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed policy globally.", "example": "managedpolicy:my-policy" }, "type": "array", "maxItems": 50, "minItems": 1, "uniqueItems": true } ] }, "MarketingInfo": { "type": "object", "properties": { "logo": { "type": "string", "description": "Logo file name" }, "promotion": { "type": "boolean", "description": "Profile promotion on marketplace" }, "processSteps": { "$ref": "#/components/schemas/ProcessSteps" } } }, "MarketplaceSubscription": { "type": "object", "properties": { "href": { "type": "string", "description": "Marketplace Subscription URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5" }, "type": { "enum": [ "AWS_MARKETPLACE_SUBSCRIPTION", "GCP_MARKETPLACE_SUBSCRIPTION", "AZURE_MARKETPLACE_SUBSCRIPTION" ], "type": "string", "description": "Marketplace Subscription type", "example": "AWS_MARKETPLACE_SUBSCRIPTION" }, "uuid": { "type": "string", "description": "Equinix-assigned Marketplace Subscription identifier", "example": "20d32a80-0d61-4333-bc03-707b591ae2f5" } }, "description": "Equinix Fabric Entity for Marketplace Subscription" }, "MediaTypes": { "type": "array", "items": { "$ref": "#/components/schemas/MediaTypesItem" } }, "MediaTypesItem": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/Name_6dba1cb7" }, "protocolTypes": { "$ref": "#/components/schemas/ProtocolTypes" }, "circuitCounts": { "$ref": "#/components/schemas/CircuitCounts" } } }, "MessageType": { "type": "object", "properties": { "asset": { "$ref": "#/components/schemas/Asset_be358951" }, "environmental": { "$ref": "#/components/schemas/Environmental" }, "power": { "$ref": "#/components/schemas/Power" }, "meteredPower": { "$ref": "#/components/schemas/MeteredPower" }, "systemAlert": { "$ref": "#/components/schemas/SystemAlert" }, "customAlert": { "$ref": "#/components/schemas/CustomAlert" } }, "description": "Message type for a given subscription" }, "Metadata": { "type": "object", "properties": { "props": { "type": "string" }, "regEx": { "type": "string" }, "regExMsg": { "type": "string" }, "vlanRangeMaxValue": { "type": "integer" }, "vlanRangeMinValue": { "type": "integer" }, "maxQinq": { "type": "string" }, "maxDot1q": { "type": "integer" }, "variableBilling": { "type": "boolean" }, "globalOrganization": { "type": "string" }, "limitAuthKeyConn": { "type": "boolean" }, "allowSecondaryLocation": { "type": "boolean" }, "redundantProfileId": { "type": "string" }, "allowVcMigration": { "type": "boolean" }, "connectionEditable": { "type": "boolean" }, "releaseVlan": { "type": "boolean" }, "maxConnectionsOnPort": { "type": "integer" }, "portAssignmentStrategy": { "type": "string" }, "eqxManagedPort": { "type": "boolean" }, "connectionNameEditable": { "type": "boolean" } }, "description": "Metadata. Response attribute. Ignored on request payload." }, "MeteredPower": { "type": "array", "items": { "$ref": "#/components/schemas/MeteredPowerItem" }, "description": "List of metered power message type to subscribe" }, "MeteredPowerItem": { "required": [ "asset", "ibx", "reading", "streamId", "tag" ], "type": "object", "properties": { "streamId": { "type": "string", "description": "unique message id", "example": "IBX.CBM-B1-4-1:kilowattHour" }, "ibx": { "type": "string", "description": "ibx", "example": "IBX" }, "asset": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "asset id", "example": "IBX.CBM-B1-4-1" }, "type": { "type": "string", "description": "asset type", "example": "Customer Billing Meter" } }, "description": "asset details" }, "cage": { "type": "string", "description": "cage", "example": "IBX:02:021305" }, "cageSerialNo": { "type": "string", "description": "cage serial number", "example": "021305-20604711" }, "accountNumber": { "type": "string", "description": "account number", "example": "123456" }, "tag": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "tag id", "example": "IBX.CBM-B1-4-1:kilowattHour" }, "displayName": { "type": "string", "description": "tag display name", "example": "kilowattHour" } }, "description": "tag details" }, "reading": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "reading value", "example": "412568.125" }, "unit": { "type": "string", "description": "reading unit", "example": "kWh" } }, "description": "reading details" }, "readingTime": { "type": "string", "description": "message reading time", "example": "2023-10-03T13:09:32" }, "dataQuality": { "type": "string", "description": "data quality - Good | Bad | Uncertain", "example": "Good" } }, "description": "message data" }, "MetricSelector": { "type": "object", "properties": { "include": { "$ref": "#/components/schemas/Include" }, "except": { "$ref": "#/components/schemas/Include" } } }, "MetricsItem": { "type": "object", "properties": { "intervalEndTimestamp": { "type": "string", "description": "Interval end timestamp", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "max": { "type": "number", "description": "Max bandwidth within statistics object time interval, represented in units specified by response \"units\" field", "format": "float" }, "mean": { "type": "number", "description": "Mean bandwidth within statistics object time interval, represented in units specified by response \"units\" field", "format": "float" } }, "description": "Bandwidth utilization statistics for a specified interval." }, "Metrics_84103b98": { "type": "array", "items": { "$ref": "#/components/schemas/MetricsItem" }, "description": "Bandwidth utilization statistics for a specified interval." }, "Metrics_c12f7323": { "type": "array", "items": { "type": "object", "properties": { "intervalDateTime": { "type": "string", "description": "The end of a polled time period.", "format": "date-time", "example": "2023-11-10T19:32:14Z" }, "mean": { "type": "number", "description": "Mean traffic throughput.", "example": 9.549439345514042 } } }, "description": "Array of polled throughput metrics" }, "Metro": { "type": "object", "properties": { "metroCode": { "type": "string", "description": "Metro code", "example": "DC" }, "metroDescription": { "type": "string", "description": "Metro description", "example": "Ashburn" }, "region": { "type": "string", "description": "A region have several metros.", "example": "AMER" }, "clusterSupported": { "type": "boolean", "description": "Whether this metro supports cluster devices", "example": false } }, "description": "Metro information" }, "MetroLinksItem_c5758fb8": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account number. Either an account number or an accountreferenceId is required to create a link group.", "example": "345678" }, "throughput": { "type": "string", "description": "Metro Throughput.", "example": "1000" }, "throughputUnit": { "type": "string", "description": "Throughput unit.", "example": "Mbps" }, "metroCode": { "type": "string", "description": "Metro you want to link.", "example": "SY" } } }, "MetroLinksItem_d4b00803": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Account name", "example": "Equinix" }, "metroCode": { "type": "string", "description": "Linked metro code", "example": "SY" }, "metroName": { "type": "string", "description": "Linked metro name", "example": "Singapore" }, "throughput": { "type": "string", "description": "Metro Throughput.", "example": "1000" }, "throughputUnit": { "type": "string", "description": "Throughput unit.", "example": "Mbps" } } }, "MetroLinks_7fdb4dcb": { "type": "array", "items": { "$ref": "#/components/schemas/MetroLinksItem_c5758fb8" }, "description": "An array of links." }, "MetroLinks_a8984f74": { "type": "array", "items": { "$ref": "#/components/schemas/MetroLinksItem_d4b00803" }, "description": "An array of links between metros." }, "Metros": { "type": "array", "items": { "$ref": "#/components/schemas/MetrosItem" }, "description": "Derived response attribute." }, "MetrosItem": { "type": "object", "properties": { "code": { "type": "string", "description": "metro code" }, "name": { "type": "string", "description": "metro name" }, "vcBandwidthMax": { "type": "integer", "description": "max VC speed supported in Mbps" }, "ibxs": { "type": "array", "items": { "type": "string", "description": "ibx codes" } }, "inTrail": { "type": "boolean" }, "displayName": { "type": "string", "description": "service metro display name" }, "sellerRegions": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Msg": { "type": "string", "description": "[Ok|Invalid Level Type|Invalid Level Value|Invalid Account Details Or User is not Entitled|User Preference is not set as expected in the account|Invalid IBX|Invalid Account number|User is not entitled to the ibx|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR|NO_DATA|UNAUTHORISZED_ACCESS] are the possible messages", "example": "OK" }, "Name_450fe5a4": { "enum": [ "ANTENNA", "DS-3", "E1", "E3", "ETHERNET", "FAST_ETHERNET", "GIGABIT_ETHERNET", "POTS", "T1", "FIBRE_CHANNEL", "10_GIG_ETHERNET", "100_GIG_ETHERNET", "40_GIG_ETHERNET", "DARK_FIBER", "DWDM", "56K", "ISDN", "OC-12", "OC-192", "OC-3", "OC-48", "STM-1", "STM-16", "STM-4", "STM-64", "NA" ], "type": "string", "description": "Name of the protocol type that corresponds with the media type.", "example": "FAST_ETHERNET" }, "Name_6dba1cb7": { "enum": [ "COAX", "MP4_CABLE", "50_MICRON_MULTI_MODE_FIBER", "50_MICRON_MULTI_MODE_FIBER_OM2", "50_MICRON_MULTI_MODE_FIBER_OM3", "50_MICRON_MULTI_MODE_FIBER_OM4", "62.5_MICRON_MULTI_MODE_FIBER", "62.5_MICRON_MULTI_MODE_FIBER_OM1", "ABAM", "CAT3", "CAT5E", "CAT6", "CAT6A", "OS1", "SINGLE_MODE_FIBER" ], "type": "string", "description": "Name of the media type that corresponds with the connection service.", "example": "SINGLE_MODE_FIBER" }, "NetworkFilter": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/NetworkSimpleExpression" }, "or": { "$ref": "#/components/schemas/NetworkSimpleExpression" }, "property": { "$ref": "#/components/schemas/NetworkSearchFieldName" }, "operator": { "enum": [ "=", "!=", ">", ">=", "<", "<=", "BETWEEN", "NOT BETWEEN", "LIKE", "NOT LIKE", "ILIKE", "NOT ILIKE", "IN", "NOT IN" ], "type": "string", "example": "=" }, "values": { "type": "array", "items": { "type": "string", "example": "Network-1" } } } }, "NetworkNotification": { "title": "NetworkNotification", "required": [ "id", "type", "startTimestamp", "ibxs", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Notification Identification.", "example": "5-122662504647" }, "type": { "enum": [ "NETWORK_INCIDENT", "NETWORK_MAINTENANCE" ], "type": "string", "description": "Notification Type.", "example": "NETWORK_MAINTENANCE" }, "startTimestamp": { "type": "string", "description": "Event/Notification start date.", "format": "date-time", "example": "2018-01-28T03:46:36.720Z" }, "endTimestamp": { "type": "string", "description": "Event/Notification start date.", "format": "date-time", "example": "2018-01-29T03:46:36.720Z" }, "ibxs": { "type": "array", "items": { "type": "string" }, "description": "List of IBX", "example": [ "SG1", "SG2" ] }, "status": { "enum": [ "EXTENDED", "RESCHEDULED", "CANCELLED", "COMPLETED", "IN_PROGRESS", "RESOLVED", "UPDATED", "NEW", "OTHER" ], "type": "string", "description": "Event/Notification Status.", "example": "RESOLVED" }, "productTypes": { "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "List of network product type (example: ETHERNET_EXCHANGE, INTERNET_EXCHANGE, CROSS_CONNECT, METRO_CONNECT, CLOUD_IX). It may return UNKNOWN if no known product type is found.", "example": [ "INTERNET_EXCHANGE", "METRO_CONNECT" ] }, "summary": { "type": "string", "description": "Summary information about the event / notification.", "example": "line card replacement of dis01.wa1" } }, "description": "Summary of Network Notification without email details." }, "NetworkSearchFieldName": { "enum": [ "/name", "/uuid", "/scope", "/type", "/state", "/operation/equinixStatus", "/location/region", "/location/metroCode", "/connectionsCount", "/project/projectId", "/account/globalCustId", "/account/orgId", "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/changeLog/deletedDateTime", "/*" ], "type": "string", "description": "Possible field names to use on filters", "example": "/name" }, "NetworkSimpleExpression": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkFilter" } }, "NetworkSortBy": { "enum": [ "/name", "/uuid", "/scope", "/operation/equinixStatus", "/location/region", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "NetworkSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/NetworkSortDirection" }, "property": { "$ref": "#/components/schemas/NetworkSortBy" } } }, "NetworkSortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "Network_16ae54fb": { "type": "object", "properties": { "href": { "type": "string", "description": "url to entity", "format": "uri" }, "uuid": { "type": "string", "description": "Network Identifier", "format": "uuid" }, "type": { "enum": [ "EVPLAN", "EPLAN", "IPWAN", "EVPTREE", "EPTREE" ], "type": "string", "description": "Type of Network" }, "name": { "type": "string", "description": "Network Name" }, "scope": { "enum": [ "LOCAL", "REGIONAL", "GLOBAL" ], "type": "string", "description": "scope of Network" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" } } }, "Network_f1775ec0": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Network URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784" }, "uuid": { "type": "string", "description": "Equinix-assigned network identifier", "format": "uuid", "example": "92dc376a-a932-43aa-a6a2-c806dedbd784" }, "name": { "type": "string", "description": "Customer-assigned network name", "example": "My EVPLAN Network" }, "state": { "enum": [ "ACTIVE", "INACTIVE", "DELETED" ], "type": "string", "description": "Network status", "example": "ACTIVE" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "change": { "$ref": "#/components/schemas/Change_18dae99f" }, "operation": { "type": "object", "properties": { "equinixStatus": { "enum": [ "PROVISIONING", "PROVISIONED", "NOT_PROVISIONED", "DEPROVISIONING", "DEPROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Network status" } }, "description": "Network operational data" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "links": { "$ref": "#/components/schemas/Links_3706c0c8" }, "type": { "enum": [ "EVPLAN", "EPLAN", "IPWAN", "EVPTREE", "EPTREE" ], "type": "string", "description": "Network type" }, "scope": { "enum": [ "REGIONAL", "GLOBAL", "LOCAL" ], "type": "string", "description": "Network scope" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" } }, "description": "Network specification" }, "Node0": { "type": "object", "properties": { "licenseFileId": { "type": "string", "description": "License file id is required for Fortinet and Juniper clusters.", "example": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc" }, "licenseToken": { "type": "string", "description": "License token is required for Palo Alto clusters.", "example": "V74191621" }, "vendorConfig": { "$ref": "#/components/schemas/VendorConfig_1126b9ef" } }, "description": "Details of node 0 in a cluster" }, "Node1": { "type": "object", "properties": { "licenseFileId": { "type": "string", "description": "License file id is required for Fortinet and Juniper clusters.", "example": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc" }, "licenseToken": { "type": "string", "description": "License token is required for Palo Alto clusters.", "example": "V74191621" }, "vendorConfig": { "$ref": "#/components/schemas/VendorConfig_039cfa6b" } }, "description": "Details of node 1 in a cluster" }, "Notes": { "maxItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/NotesItem" }, "description": "Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL." }, "NotesItem": { "type": "object", "properties": { "href": { "type": "string", "description": "Note URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Note Identifier.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "parentNote": { "$ref": "#/components/schemas/ParentNote_1a60856f" }, "comments": { "maxLength": 4000, "type": "string", "description": "Note comments.", "example": "Please proceed" } }, "description": "Note the action applies to." }, "NotificationEmail": { "title": "NotificationEmail", "type": "object", "properties": { "subject": { "type": "string", "description": "Subject of ibx notification email.", "example": "FR METRO AREA NEW INCIDENT NOTIFICATION - [5-122720103065]" }, "body": { "$ref": "#/components/schemas/Body_f11126d9" }, "timestamp": { "type": "string", "description": "IBX Notification event Email information received time.", "format": "date-time", "example": "2018-01-28T03:46:36.720Z" } } }, "NotificationsItem_037f56a6": { "required": [ "type", "emails" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "ORDERING", "TECHNICAL" ], "type": "string", "description": "Notification category.
NOTIFICATION - states and configuration updates.
ORDERING - order and fulfilment correspondence.
TECHNICAL - maintenance and technical advisories.\n", "example": "NOTIFICATION" }, "emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Email addresses to notify." }, "registeredUsers": { "type": "array", "items": { "type": "string" }, "description": "Usernames of registered Equinix Portal users to notify." } }, "description": "Notification preferences for this connection." }, "NotificationsItem_49b424e4": { "required": [ "type", "emails" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "BANDWIDTH_ALERT", "CONNECTION_APPROVAL", "PROFILE_LIFECYCLE", "ALL", "SALES_REP_NOTIFICATIONS", "TECHNICAL", "ORDERING", "QUOTE_NOTIFICATIONS" ], "type": "string", "description": "Notification Type", "example": "BANDWIDTH_ALERT" }, "sendInterval": { "type": "string" }, "emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Array of contact emails" }, "registeredUsers": { "type": "array", "items": { "type": "string" }, "description": "Array of registered users" }, "phone": { "$ref": "#/components/schemas/Phone_056c6ebf" } } }, "NotificationsItem_7e3eb641": { "required": [ "type", "emails" ], "type": "object", "properties": { "type": { "enum": [ "ORDERING", "TECHNICAL", "NOTIFICATION", "PROVIDER_NOTIFICATION", "TECHNICAL_UNREGISTERED" ], "type": "string", "description": "Notification Type.", "example": "TECHNICAL" }, "firstName": { "type": "string", "description": "First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.\n", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.\n", "example": "Doe" }, "emails": { "type": "array", "items": { "type": "string", "format": "email" }, "description": "Email addresses for notifications.", "example": [ "abc@test.com" ] }, "registeredUsers": { "type": "array", "items": { "type": "string" }, "description": "Registered users for notifications." }, "phone": { "$ref": "#/components/schemas/Phone_bb642f5d" } }, "description": "Cross Connect Notification." }, "NotificationsItem_bbf1b20e": { "required": [ "type", "registeredUsers" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "TECHNICAL", "PEERING", "ESCALATION", "ORDERING" ], "type": "string", "description": "Internet Exchange Service Notification Type" }, "registeredUsers": { "type": "array", "items": { "type": "string" }, "description": "Array of registered users" } } }, "Notifications_0246edb6": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_49b424e4" }, "description": "Preferences for stream notifications, set at creation" }, "Notifications_4779732b": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_49b424e4" }, "description": "Preferences for notifications on network configuration or status changes" }, "Notifications_57addba0": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_037f56a6" }, "description": "Preferences for notifications on connection configuration or status changes" }, "Notifications_7885f438": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_7e3eb641" }, "description": "Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect.\n" }, "Notifications_7cbe42a5": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_7e3eb641" }, "description": "Preferences for notifications on Cross Connect configuration or status changes.\n" }, "Notifications_903ff2b6": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_49b424e4" }, "description": "Preferences for notifications on connection configuration or status changes" }, "Notifications_9750afd0": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_49b424e4" }, "description": "Service token related notifications" }, "Notifications_a0ca161e": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_bbf1b20e" }, "description": "Preferences for notifications on Internet Exchange Service configuration or status changes" }, "Notifications_ccb07798": { "type": "array", "items": { "required": [ "type", "registeredUsers" ], "type": "object", "properties": { "type": { "enum": [ "NOTIFICATION", "TECHNICAL", "PEERING", "ESCALATION" ], "type": "string", "description": "Notification Type" }, "registeredUsers": { "type": "array", "items": { "type": "string" }, "description": "Array of registered users" } } }, "description": "Notification preferences" }, "Notifications_d2262128": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_037f56a6" }, "description": "Contacts to notify about connection configuration and status changes" }, "Notifications_ebd7698b": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_49b424e4" }, "example": [ { "type": "NOTIFICATION", "emails": [ "example1@example.com", "example2@example.com" ] } ] }, "Notifications_f30d1188": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsItem_49b424e4" }, "description": "Recipients of notifications on service profile change" }, "Notifications_get_ibx_NotificationResult": { "properties": { "emails": { "$ref": "#/components/schemas/Emails" } } }, "NtpAdvancedConfiguration": { "type": "array", "items": { "$ref": "#/components/schemas/NtpAdvancedConfigurationItem" }, "description": "NTP Advanced configuration - MD5 Authentication." }, "NtpAdvancedConfigurationItem": { "type": "object", "properties": { "type": { "enum": [ "ASCII", "HEX" ], "type": "string" }, "keyNumber": { "maximum": 65535.0, "minimum": 1.0, "type": "integer", "description": "The authentication Key ID.", "example": 10 }, "key": { "$ref": "#/components/schemas/Key" } } }, "Offerings": { "type": "array", "items": { "$ref": "#/components/schemas/OfferingsItem" }, "description": "Available last-mile offerings." }, "OfferingsItem": { "type": "object", "properties": { "bandwidth": { "type": "integer", "description": "Offered bandwidth in Mbps.", "example": 10 }, "price": { "$ref": "#/components/schemas/Price_cb97de4c" } }, "description": "Last-mile offering details." }, "Operation_21b488ab": { "type": "object", "properties": { "operationalStatus": { "enum": [ "UP", "DOWN", "PARTIAL" ], "type": "string", "description": "Availability of a given physical port." }, "connectionCount": { "type": "integer", "description": "Total number of connections.", "format": "int64" }, "evplVCCount": { "type": "integer", "description": "Total number of connections.", "format": "int64" }, "fgVCCount": { "type": "integer", "description": "Total number of connections.", "format": "int64" }, "accessVCCount": { "type": "integer", "description": "Total number of connections.", "format": "int64" }, "opStatusChangedAt": { "type": "string", "description": "Date and time at which port availability changed.", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "maintenanceStatus": { "allOf": [ { "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED", "POSTPONED" ], "type": "string", "description": "Maintenance lifecycle state", "example": "SCHEDULED" } ] }, "lockEnabled": { "type": "boolean", "description": "Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance.", "example": true } }, "description": "Operational specifications for ports." }, "Operation_2a3fcb9f": { "allOf": [ { "$ref": "#/components/schemas/Operation_21b488ab" } ] }, "Operation_4b006c02": { "type": "object", "properties": { "eventsDeliveredCount": { "type": "integer", "description": "count of delivered events" }, "metricsDeliveredCount": { "type": "integer", "description": "count of delivered metrics" }, "alertsDeliveredCount": { "type": "integer", "description": "count of delivered alerts" }, "lastSuccessfulDeliveryDateTime": { "type": "string", "description": "last successful date time of delivered event, metric, or alert", "format": "date-time" }, "suspendedDateTime": { "type": "string", "description": "suspended date time of stream subscription delivery for event, metric, or alert", "format": "date-time" }, "errors": { "$ref": "#/components/schemas/Errors_20cb1774" } }, "description": "Stream subscription operational information" }, "Operation_6c0cfed5": { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/Errors_a7ba79b3" } } }, "Operation_b2cbabaa": { "type": "object", "properties": { "bgpIpv4RoutesCount": { "type": "integer", "description": "IPV4 route count", "example": 6 }, "bgpIpv6RoutesCount": { "type": "integer", "description": "IPV6 route count", "example": 6 }, "distinctIpv4PrefixesCount": { "type": "integer", "description": "distinct IPV4 prefixes count", "example": 4 }, "distinctIpv6PrefixesCount": { "type": "integer", "description": "distinct IPV6 prefixes count", "example": 4 } }, "description": "Operation object for router actions" }, "Operation_e2c43536": { "type": "object", "properties": { "providerStatus": { "$ref": "#/components/schemas/ProviderStatus" }, "equinixStatus": { "$ref": "#/components/schemas/EquinixStatus" }, "operationalStatus": { "enum": [ "UP", "DOWN" ], "type": "string", "description": "Connection operational status" }, "errors": { "$ref": "#/components/schemas/Errors_a7ba79b3" }, "opStatusChangedAt": { "type": "string", "description": "When connection transitioned into current operational status", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "maintenanceStatus": { "allOf": [ { "enum": [ "SCHEDULED", "IN_PROGRESS", "COMPLETED", "CANCELLED", "POSTPONED" ], "type": "string", "description": "Maintenance lifecycle state", "example": "SCHEDULED" } ] }, "lockEnabled": { "type": "boolean", "description": "Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance.", "example": true } }, "description": "Connection type-specific operational data" }, "Operation_efa7ab78": { "type": "object", "properties": { "operationalStatus": { "enum": [ "UP", "DOWN", "UNKNOWN" ], "type": "string", "description": "BGP IPv4 or IPv6 Connection State operational status" }, "opStatusChangedAt": { "type": "string", "description": "Last BGP State Update by Date and Time", "format": "date-time", "example": "2021-10-30T07:21:39Z" } }, "description": "BGP IPv4 or IPv6 Connection State operational data" }, "OperationalUnits": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalUnitsItem" } }, "OperationalUnitsItem": { "required": [ "ibxs" ], "type": "object", "properties": { "ibxs": { "type": "array", "items": { "required": [ "ibx" ], "type": "object", "properties": { "ibx": { "type": "string", "example": "WA1" } } } }, "metros": { "type": "array", "items": { "required": [ "metroCode" ], "type": "object", "properties": { "metroCode": { "type": "string", "example": "WA" } } } } } }, "Operator_64b8e854": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `>` - greater than\n * `>=` - greater than or equal to\n * `<` - less than\n * `<=` - less than or equal to\n * `BETWEEN` - between\n * `NOT BETWEEN` - not between\n * `LIKE` - like\n * `ILIKE` - like case-insensitive\n * `IN` - in\n * `NOT IN` - not in\n", "example": "=" }, "Operator_81d6289e": { "allOf": [ { "enum": [ "=", "!=", "LIKE", "NOT LIKE", "ILIKE", "NOT ILIKE", "IN", "NOT IN" ], "type": "string", "description": "Comparison operators for filtering", "example": "=" } ], "description": "Comparison operator. `LIKE`, `NOT LIKE`, `ILIKE`, and `NOT ILIKE` require exactly one value. All other operators accept one or more values.\n * `=` - equal; equivalent to `IN` when multiple values are provided\n * `!=` - not equal; equivalent to `NOT IN` when multiple values are provided\n * `LIKE` - case-sensitive partial match (single value)\n * `NOT LIKE` - case-sensitive partial non-match (single value)\n * `ILIKE` - case-insensitive partial match (single value)\n * `NOT ILIKE` - case-insensitive partial non-match (single value)\n * `IN` - matches any of the provided values\n * `NOT IN` - does not match any of the provided values\n", "example": "IN" }, "Operator_a87d6981": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `>` - greater than\n * `>=` - greater than or equal to\n * `<` - less than\n * `<=` - less than or equal to\n * `[NOT] BETWEEN` - (not) between\n * `[NOT] LIKE` - (not) like\n * `[NOT] IN` - (not) in\n * `~*` - case-insensitive like\n", "example": "=" }, "Operator_e348ff21": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `>` - greater than\n * `<` - less than\n * `IN` - in\n * `NOT IN` - not in\n * `LIKE` - like\n * `ILIKE` - case-insensitive like\n * `BETWEEN` - between\n * `NOT BETWEEN` - not between\n", "example": "=" }, "Or": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/AndItem_2aa4a34a" } }, "OrItem": { "type": "object", "properties": { "property": { "enum": [ "/token", "/products/zSide/patchPanel/location/ibx", "/state", "/provider/name", "/requestor/name", "/provider/orgIds", "/requestor/orgIds" ], "type": "string", "description": "Search property name", "example": "/token" }, "operator": { "enum": [ "", "IN", "LIKE", "CONTAINS" ], "type": "string", "description": "Criterion operator", "example": "" }, "values": { "minItems": 1, "type": "array", "items": { "type": "string", "description": "Criterion value", "example": "RE4E-91PA" }, "description": "Criterion values" } }, "description": "Search criterion item" }, "Order_3d5e2642": { "required": [ "changeLog", "href", "number", "status", "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Order URI", "example": "https://api.equinix.com/internetAccess/v1/orders/cd67f685-41b0-1b07-6de0-320a5c00abee" }, "uuid": { "type": "string", "format": "uuid" }, "type": { "enum": [ "NEW", "AMENDMENT" ], "type": "string" }, "status": { "enum": [ "PROCESSING", "AWAITING_SIGNATURE", "SIGNATURE_REJECTED", "SIGNATURE_EXPIRED", "SUBMITTED", "COMPLETED", "FAILED" ], "type": "string", "description": "Order status", "example": "COMPLETED" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "number": { "type": "string", "description": "Order number", "example": "1-9234239473" } } }, "Order_3e7328e1": { "type": "object", "properties": { "purchaseOrderNumber": { "type": "string", "description": "Purchase order number" }, "customerReferenceNumber": { "type": "string", "description": "Customer reference number" }, "billingTier": { "type": "string", "description": "Billing tier for connection bandwidth" }, "orderId": { "type": "string", "description": "Order Identification" }, "orderNumber": { "type": "string", "description": "Order Reference Number" }, "termLength": { "maximum": 60.0, "minimum": 1.0, "type": "integer", "description": "Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).", "default": 1 }, "contractedBandwidth": { "type": "integer", "description": "Contracted bandwidth" } } }, "Order_41b238f5": { "type": "object", "properties": { "orderNumber": { "type": "string", "description": "Order Number.", "example": "1-1234567890" }, "orderLineItemNumber": { "type": "string", "description": "Order Line Item Number.", "example": "1-1234567890" }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrder_b7dda539" }, "customerReferenceId": { "type": "string", "description": "Customer Reference Identifier.", "example": "12345" } }, "description": "Cross Connect Order." }, "Order_42dc2ad5": { "type": "object", "properties": { "purchaseOrderNumber": { "type": "string", "description": "Purchase order number reference.", "example": "156576" }, "orderId": { "type": "string", "description": "Equinix-assigned order identifier." }, "customerReferenceId": { "type": "string", "description": "Your own reference for this Exchange Service." }, "orderNumber": { "type": "string", "description": "Equinix order reference number.", "example": "1-129105284100" }, "orderLineItemNumber": { "type": "string", "description": "Order Reference Number for Sales Assisted Order" }, "domainOrderNumber": { "type": "string", "description": "product domain Order Number for Sales Assisted Order" }, "uuid": { "type": "string", "description": "Equinix-assigned order identifier, this is a derived response attribute", "format": "uuid" } }, "description": "Ordering and billing reference details for this Exchange Service." }, "Order_47faa772": { "type": "object", "properties": { "contacts": { "$ref": "#/components/schemas/Contacts_b1e4be6d" }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrder_5185db24" }, "referenceNumber": { "type": "string", "example": "239384723943" }, "signature": { "$ref": "#/components/schemas/Signature_82273560" } } }, "Order_68fbde57": { "required": [ "changeLog", "draft", "href", "links", "number", "status", "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Order URI", "example": "https://api.equinix.com/internetAccess/v1/orders/cd67f685-41b0-1b07-6de0-320a5c00abee" }, "uuid": { "type": "string", "description": "Order identifier", "format": "uuid", "example": "cd67f685-41b0-1b07-6de0-320a5c00abee" }, "type": { "enum": [ "NEW", "AMENDMENT" ], "type": "string", "description": "Order type", "example": "NEW" }, "draft": { "type": "boolean", "description": "Describes if the service is a draft", "example": true }, "status": { "enum": [ "DRAFT", "PROCESSING", "AWAITING_SIGNATURE", "SIGNATURE_REJECTED", "SIGNATURE_EXPIRED", "SUBMITTED", "COMPLETED", "FAILED" ], "type": "string", "description": "Order status", "example": "COMPLETED" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "number": { "type": "string", "description": "Order number", "example": "1-9234239473" }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrder_dd8d6ac0" }, "contacts": { "$ref": "#/components/schemas/Contacts_b1e4be6d" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] }, "links": { "$ref": "#/components/schemas/Links_8561166d" } } }, "Order_756ea9ac": { "allOf": [ { "$ref": "#/components/schemas/Order_3e7328e1" }, { "type": "object", "properties": { "href": { "type": "string", "description": "Order URI", "format": "uri", "example": "https://api.equinix.com/colocations/v2/orders/100200300" } } } ] }, "Order_95704d9c": { "type": "object", "properties": { "purchaseOrderNumber": { "type": "string", "description": "Purchase order number reference.", "example": "PO-156576" }, "customerReferenceId": { "type": "string", "description": "Your own reference for this connection." }, "orderNumber": { "type": "string", "description": "Equinix order reference number.", "example": "1-129105284100" } }, "description": "Ordering and billing reference details for this connection." }, "Order_9b002780": { "type": "object", "properties": { "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrder_6501a121" }, "customerReferenceId": { "type": "string", "description": "Customer order reference Id" }, "signature": { "$ref": "#/components/schemas/Signature_2cdb41af" } } }, "Order_Contacts_Array": { "title": "Order Contacts Array", "minItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/Contact_Info_4b42a509" }, "description": "Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more notification contacts are allowed. Ordering and notification contacts are always registered customers with the customer portal.", "example": [ { "contactType": "ORDERING", "userName": "jondoe@test.com" }, { "contactType": "NOTIFICATION", "userName": "jondoe@test.com" }, { "contactType": "TECHNICAL", "name": "John Doe", "workPhone": "1111111", "workPhonePrefToCall": "ANYTIME", "mobilePhone": "1111111", "mobilePhonePrefToCall": "ANYTIME" } ] }, "Order_Header_Status_Enum": { "title": "Order Header Status Enum", "enum": [ "ENTERED", "SUBMITTED", "IN_PROGRESS", "PENDING_QA", "CANCELLED", "CLOSED" ], "type": "string", "description": "ENTERED: Order Created.
SUBMITTED: When the order is assigned to the Equinix OPS team.
IN_PROGRESS: When the order fulfillment is in progress
PENDING_QA: The order couldn't be submitted. This order required manual intervention from Equinix end.
CANCELLED: The order is canceled.
CLOSED: Order is closed.", "example": "SUBMITTED" }, "Order_cee822fd": { "allOf": [ { "$ref": "#/components/schemas/Order_41b238f5" } ], "description": "Applicable for XC_DEINSTALL. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect.\n" }, "Order_fb21beeb": { "allOf": [ { "$ref": "#/components/schemas/Order_47faa772" }, { "$ref": "#/components/schemas/Order_3d5e2642" } ] }, "OutputStructuredPing": { "type": "object", "properties": { "destinationIp": { "type": "string", "example": "8.8.8.8" }, "destinationName": { "type": "string", "example": "8.8.8.8" }, "dataBytes": { "type": "integer", "example": 100 }, "packetsTransmitted": { "type": "integer", "example": 4 }, "packetsReceived": { "type": "integer", "example": 4 }, "packetsLossPercent": { "type": "number", "format": "float", "example": 0 }, "rttMin": { "type": "number", "format": "float", "example": 9.271 }, "rttAvg": { "type": "number", "format": "float", "example": 15.483 }, "rttMax": { "type": "number", "format": "float", "example": 26.771 }, "rttStdDev": { "type": "number", "format": "float", "example": 7.039 }, "responses": { "type": "array", "items": { "type": "object", "properties": { "bytes": { "type": "integer", "example": 100 }, "ip": { "type": "string", "example": "8.8.8.8" }, "icmpSeq": { "type": "integer", "example": 0 }, "ttl": { "type": "integer", "example": 117 }, "time": { "type": "number", "format": "float", "example": 9.839 } } } } } }, "OutputStructuredTraceroute": { "type": "object", "properties": { "destinationIp": { "type": "string", "example": "8.8.8.8" }, "destinationName": { "type": "string", "example": "8.8.8.8" }, "packetBytes": { "type": "integer", "example": 60 }, "hopsMax": { "type": "integer", "example": 10 }, "hops": { "$ref": "#/components/schemas/Hops" } } }, "Package": { "required": [ "code" ], "type": "object", "properties": { "href": { "type": "string", "description": "Fabric Cloud Router URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routerPackages/LAB" }, "type": { "enum": [ "ROUTER_PACKAGE" ], "type": "string", "description": "Cloud Router package type", "example": "ROUTER_PACKAGE" }, "code": { "enum": [ "LAB", "BASIC", "STANDARD", "ADVANCED", "PREMIUM" ], "type": "string", "description": "Cloud Router package code", "example": "LAB" } }, "description": "Fabric Cloud Router Package Type" }, "Page": { "title": "Page", "required": [ "total", "limit", "offset" ], "type": "object", "properties": { "total": { "minimum": 0.0, "type": "integer", "description": "Total number of records", "default": 0 }, "limit": { "minimum": 0.0, "type": "integer", "description": "Number of records per page", "default": 0 }, "offset": { "minimum": 0.0, "type": "integer", "description": "The page number", "default": 0 }, "sorts": { "type": "array", "items": { "type": "string" }, "description": "Sort fields based on polarity" } }, "example": { "total": 54690858, "limit": 21446016, "offset": 60463582, "sorts": [ "cupidatat", "dolor occaecat" ] } }, "PageInfo": { "title": "PageInfo", "type": "object", "properties": { "limit": { "type": "integer", "description": "Starting count based on offset.", "example": 10 }, "offset": { "type": "integer", "description": "Limit count per page.", "example": 30 }, "total": { "type": "integer", "description": "Matching record count / total number records matched with filter.", "example": 223 }, "sorts": { "type": "array", "items": { "type": "string" }, "example": [ "id", "-date" ] } } }, "Pagination": { "required": [ "limit", "total" ], "type": "object", "properties": { "offset": { "minimum": 0.0, "type": "integer", "description": "Index of the first item returned in the response. The default is 0.", "default": 0 }, "limit": { "minimum": 0.0, "type": "integer", "description": "Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.", "default": 20 }, "total": { "minimum": 0.0, "type": "integer", "description": "Total number of elements returned." }, "next": { "type": "string", "description": "URL relative to the next item in the response." }, "previous": { "type": "string", "description": "URL relative to the previous item in the response." } }, "description": "Pagination response information" }, "PaginationRequest": { "type": "object", "properties": { "offset": { "minimum": 0.0, "type": "integer", "description": "Index of the first element.", "default": 0 }, "limit": { "minimum": 1.0, "type": "integer", "description": "Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.", "default": 20 } }, "description": "Pagination request information" }, "PaginationResponse": { "required": [ "offset", "limit", "total" ], "type": "object", "properties": { "offset": { "type": "integer", "description": "It is the starting point of the collection returned from the server", "example": 0 }, "limit": { "type": "integer", "description": "The page size", "example": 20 }, "total": { "type": "integer", "description": "The total number of results", "example": 1 } } }, "Pagination_25a0752b": { "required": [ "limit", "offset", "total" ], "type": "object", "properties": { "offset": { "type": "integer", "description": "The number of elements to skip.", "format": "int64" }, "limit": { "type": "integer", "description": "The page size.", "format": "int64" }, "total": { "type": "integer", "description": "The total number of elements in the result set.", "format": "int64" }, "next": { "type": "string", "description": "Represents a relative link to the next page. This can be empty if there is no next page available." }, "previous": { "type": "string", "description": "Represents a relative link to the previous page. This can be empty if there is no previous page available." } }, "description": "Represents pagination component of the paginated response" }, "Pagination_a031516d": { "required": [ "limit", "offset", "total" ], "type": "object", "properties": { "offset": { "minimum": 0.0, "type": "integer", "format": "int64", "example": 0 }, "limit": { "minimum": 0.0, "type": "integer", "format": "int64", "example": 20 }, "total": { "type": "integer", "format": "int64", "example": 2 }, "next": { "type": "string", "description": "Next page link" }, "previous": { "type": "string", "description": "Previous page link" } } }, "Parameter": { "title": "Parameter", "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "description": "Parameter name" }, "value": { "minLength": 1, "type": "string", "description": "Parameter value" }, "type": { "enum": [ "ARRAY", "STRING", "LONG", "INT", "BOOLEAN", "DOUBLE", "JSON", "JSON_ARRAY" ], "type": "string", "description": "Parameter type" }, "required": { "type": "boolean", "description": "Flag to indicate the parameter is required or optional" } }, "example": { "name": "user_key", "value": "143534,908373", "type": "ARRAY", "required": true } }, "Parameters_8d62e39d": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "description": "Parameters for the reports to be generated" }, "Parameters_de963ee8": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Parameter" }, "description": "List of input parameters" }, "Parent": { "properties": { "id": { "type": "string", "description": "Id the project that owns this port", "example": "07218c48-343d-43e2-9831-a2080445cd22" }, "type": { "type": "string", "enum": [ "PROJECT" ], "example": "PROJECT" }, "name": { "type": "string", "description": "Name of object refered to by assignmentScope id", "example": "My Project" } }, "additionalProperties": false, "type": "object", "required": [ "id", "type" ], "description": "When assignmentScope type is PORT, this must be the owning project." }, "ParentNote_1a60856f": { "allOf": [ { "$ref": "#/components/schemas/ParentNote_9dc706ff" } ], "description": "The note this note is responding to. Returned when the note was added in response to an Equinix note.\n" }, "ParentNote_9dc706ff": { "required": [ "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Parent note URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Parent note UUID.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" } }, "description": "Note that this note is responding to." }, "PatchEquipment": { "required": [ "cabinetId", "connectorType", "port", "details" ], "type": "object", "properties": { "cabinetId": { "type": "string", "description": "Device Cabinet Id. The cabinet for patching must belong to the specific cage defined in the A-side details." }, "connectorType": { "type": "string", "description": "Device Connector Type to facilitate cross connection. ", "example": "BNC" }, "details": { "maxLength": 4000, "minLength": 1, "type": "string", "description": "Provide additional information to facilitate patch equipment connection", "example": "Call the technical contact before patching. " }, "port": { "type": "number", "description": "Device port number to be connected" } }, "description": "Patch equipment is chargeable as an additional service. This request will enable Equinix to install the cross connect from demarcation panel to your equipment." }, "PatchPanel_06ef935c": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Patch Panel ID" }, "portA": { "type": "number", "description": "Specify the desired port number for port A. When ports are not selected, next available ports will be used" }, "portB": { "type": "number", "description": "Specify the desired port number for port B. When ports are not selected, next available ports will be used. If no selection is required, use value of `-1`" } }, "description": "The patch panel is a device which has a series of connector ports. This device is to identify the source and destination location to connect. Patch Panel can be installed with a cabinet." }, "PatchPanel_1ebf84a5": { "required": [ "cabinetSpaceId", "cageSpaceId", "id", "location" ], "type": "object", "properties": { "id": { "type": "string", "description": "Patch panel identifier.", "example": "CP:0218:0102:13008148" }, "cabinetSpaceId": { "type": "string", "description": "Cabinet space identifier.", "example": "TY1:04:000050:1613-S14" }, "cageSpaceId": { "type": "string", "description": "Cage space identifier.", "example": "TY1:04:000050" }, "location": { "$ref": "#/components/schemas/Location_f0aa0dcf" } } }, "PathType_2d3cf468": { "enum": [ "DUAL_DIVERSE", "PROTECTED", "UNPROTECTED" ], "type": "string", "description": "Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.\n" }, "PathType_63f97b0d": { "enum": [ "DUAL_DIVERSE", "PROTECTED", "UNPROTECTED" ], "type": "string", "description": "Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.\n", "example": "PROTECTED" }, "PayLoadItem": { "type": "object", "properties": { "value": { "type": "string", "description": "Current data value for the tag point", "example": "4.9" }, "tagId": { "type": "string", "description": "ID for the tagPoint - Unique Identifier for the Tag Point", "example": "CH1.Chiller-1:evapleavingwatertemperature" }, "tagDisplayName": { "type": "string", "description": "Generic label for the tag point", "example": "Evaporator Leaving Water Temperature" }, "uom": { "type": "string", "description": "Unit of measure for the data value for the tag point", "example": "°C" }, "readingTime": { "type": "string", "description": "date time when the tag point value was read from the device.", "example": "20170907125336" } }, "description": "Tag Point is a property of the Asset it is linked to." }, "PayLoad_90f61cdf": { "type": "object", "properties": { "ibx": { "type": "string", "description": "ibx code", "example": "CH1" }, "accountNo": { "type": "string", "description": "account number", "example": "1" }, "zone": { "type": "string", "description": "zone unique space id", "example": "CH1:1:05:ColoArea:2" }, "cage": { "type": "string", "description": "cage unique space id", "example": "CH1:05:000550" }, "cabinet": { "type": "string", "description": "cabinet unique space id", "example": "CH1:05:000550:0105" }, "sensor": { "type": "string", "description": "sensor id", "example": "CH1.Colo.CH1_05_000550_0105" }, "temperature": { "type": "string", "description": "current temperature", "example": "20.0" }, "humidity": { "type": "string", "description": "current humidity", "example": "43.00" }, "timestamp": { "type": "string", "description": "epoch timestamp when the current reading was read", "example": "1506665106579" }, "temperatureUom": { "type": "string", "description": "unit of measure for temperature values", "example": "°C" }, "humidityUom": { "type": "string", "description": "unit of measure for humidity", "example": "%" } } }, "PayLoad_da0f51e0": { "type": "array", "items": { "$ref": "#/components/schemas/PayLoadItem" } }, "Payment": { "title": "Payment", "required": [ "paymentId", "date", "amount", "status" ], "type": "object", "properties": { "paymentId": { "minLength": 1, "type": "string", "description": "Identifier for the payment, payment receipt number" }, "date": { "type": "string", "description": "Payment created date", "format": "date" }, "status": { "enum": [ "APPLIED", "UNAPPLIED" ], "type": "string", "description": "Status of the payment" }, "amount": { "type": "number", "description": "Amount of the payment", "format": "double" } }, "example": { "paymentId": "123435", "amount": 43218.79, "date": "2017-03-23", "type": "APPLIED" } }, "Payments": { "type": "array", "items": { "$ref": "#/components/schemas/Payment" }, "description": "Available payments for the account" }, "PeeringIpv4": { "type": "object", "properties": { "prefix": { "pattern": "^([01]?\\d\\d?|2[0-4]\\d|25[0-5])(?:\\.(?:[01]?\\d\\d?|2[0-4]\\d|25[0-5])){3}/(?:[1-9]|[12]\\d|3[0-2])$", "type": "string", "description": "IPv4 prefix for the peering connection" }, "prefixLength": { "maximum": 32.0, "minimum": 1.0, "type": "integer", "description": "Determines the size of subnet", "example": 30 }, "equinixPeerIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 peering IP address for Equinix side" }, "customerPeerIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 peering IP address for customer side" }, "equinixVrrpIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 address for Equinix VRRP IP" }, "customerVrrpIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string", "description": "IPv4 address for customer VRRP IP" } } }, "PeeringIpv6": { "type": "object", "properties": { "prefix": { "type": "string", "description": "IPv6 prefix for the peering connection" }, "prefixLength": { "maximum": 128.0, "minimum": 8.0, "type": "integer", "description": "Determines the size of subnet", "example": 64 }, "equinixPeerIp": { "type": "string", "description": "IPv6 peering IP address for Equinix side" }, "customerPeerIp": { "type": "string", "description": "IPv6 peering IP address for customer side" }, "equinixVrrpIp": { "type": "string", "description": "IPv6 address for Equinix VRRP IP" }, "customerVrrpIp": { "type": "string", "description": "IPv6 address for customer VRRP IP" } } }, "PeeringsItem_5537a4a8": { "required": [ "equinixPeerIps", "peerSubnet", "vrrpEnabled" ], "type": "object", "properties": { "connections": { "$ref": "#/components/schemas/Connections_ed416f2a" }, "customerPeerIps": { "type": "array", "items": { "type": "string" } }, "peerSubnet": { "required": [ "prefix", "prefixLength" ], "type": "object", "properties": { "prefix": { "type": "string", "description": "Subnet used for peering", "example": "2000:3333:0000:0000:0000:0000:0000:0000/64" }, "prefixLength": { "maximum": 128.0, "minimum": 8.0, "type": "integer", "format": "int32", "example": 64 } } }, "vrrpEnabled": { "type": "boolean", "description": "Indicates if VRRP is enabled.", "example": true }, "equinixPeerIps": { "$ref": "#/components/schemas/EquinixPeerIps" }, "equinixVRRPIp": { "$ref": "#/components/schemas/EquinixPeerIpsItem" }, "customerVRRPIp": { "$ref": "#/components/schemas/EquinixPeerIpsItem" } } }, "PeeringsItem_589c8cbf": { "required": [ "equinixPeerIps", "peerSubnet", "vrrpEnabled" ], "type": "object", "properties": { "connections": { "$ref": "#/components/schemas/Connections_ed416f2a" }, "customerPeerIps": { "type": "array", "items": { "type": "string" } }, "peerSubnet": { "required": [ "prefix", "prefixLength" ], "type": "object", "properties": { "prefix": { "type": "string", "description": "Subnet used for peering", "example": "7.7.7.0/30" }, "prefixLength": { "maximum": 32.0, "minimum": 8.0, "type": "integer", "format": "int32", "example": 30 } } }, "vrrpEnabled": { "type": "boolean", "description": "Indicates if VRRP is enabled.", "example": true }, "equinixPeerIps": { "type": "array", "items": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } }, "equinixVRRPIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" }, "customerVRRPIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } }, "PeeringsItem_a4c1a34d": { "required": [ "equinixPeerIps", "peerSubnet", "vrrpEnabled" ], "type": "object", "properties": { "connections": { "$ref": "#/components/schemas/Connections_463653ff" }, "customerPeerIps": { "type": "array", "items": { "type": "string" } }, "peerSubnet": { "required": [ "prefix", "prefixLength" ], "type": "object", "properties": { "prefix": { "type": "string", "description": "Subnet used for peering", "example": "2000:3333:0000:0000:0000:0000:0000:0000/64" }, "prefixLength": { "maximum": 128.0, "minimum": 8.0, "type": "integer", "format": "int32", "example": 64 } } }, "vrrpEnabled": { "type": "boolean", "description": "Indicates if VRRP is enabled.", "example": true }, "equinixPeerIps": { "$ref": "#/components/schemas/EquinixPeerIps" }, "equinixVRRPIp": { "$ref": "#/components/schemas/EquinixPeerIpsItem" }, "customerVRRPIp": { "$ref": "#/components/schemas/EquinixPeerIpsItem" } } }, "PeeringsItem_ece21362": { "required": [ "equinixPeerIps", "peerSubnet", "vrrpEnabled" ], "type": "object", "properties": { "connections": { "$ref": "#/components/schemas/Connections_463653ff" }, "customerPeerIps": { "type": "array", "items": { "type": "string" } }, "peerSubnet": { "required": [ "prefix", "prefixLength" ], "type": "object", "properties": { "prefix": { "type": "string", "description": "Subnet used for peering", "example": "7.7.7.0/30" }, "prefixLength": { "maximum": 32.0, "minimum": 8.0, "type": "integer", "format": "int32", "example": 30 } } }, "vrrpEnabled": { "type": "boolean", "description": "Indicates if VRRP is enabled.", "example": true }, "equinixPeerIps": { "type": "array", "items": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } }, "equinixVRRPIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" }, "customerVRRPIp": { "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", "type": "string" } } }, "Peerings_1ee60942": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PeeringsItem_589c8cbf" } }, "Peerings_5d51f951": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PeeringsItem_5537a4a8" } }, "Peerings_6d1b52c8": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PeeringsItem_a4c1a34d" } }, "Peerings_72fc3c98": { "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/PeeringsItem_ece21362" } }, "PermissionSetId_aebbfdbe": { "description": "Uniquely identifies a PermissionSet within a project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "anyOf": [ { "type": "string", "pattern": "^permissionset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a PermissionSet within a project.", "example": "permissionset:my-set" }, { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } ] }, "PermissionSetId_c6d1426e": { "anyOf": [ { "type": "string", "pattern": "^permissionset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a PermissionSet within a project.", "example": "permissionset:my-set" }, { "type": "string", "pattern": "^managedset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed permission set globally.", "example": "managedset:my-set" } ] }, "PermissionSet_7ed0c398": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "permissions": { "$ref": "#/components/schemas/Permissions_0c73f7d1" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "ern": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "managed": { "enum": [ true ], "example": true }, "intersect": { "$ref": "#/components/schemas/Intersect" }, "subtract": { "$ref": "#/components/schemas/Subtract_46ea2c39" }, "permissionSetId": { "$ref": "#/components/schemas/PermissionSetId_c6d1426e" }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "tags", "permissions", "rev", "ern", "permissionSetId" ], "title": "PermissionSet", "description": "A named, reusable set of permissions within a project.", "x-fastmcp-top-level-schema": "PermissionSet" }, "PermissionSet_b010baad": { "anyOf": [ { "type": "string", "pattern": "^permissionset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a PermissionSet within a project.", "example": "permissionset:my-set" }, { "type": "string", "pattern": "^managedset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed permission set globally.", "example": "managedset:my-set" }, { "$ref": "#/components/schemas/ForeignAccessPolicy" } ] }, "PermissionsItem_7d16b03e": { "properties": { "permissionSet": { "$ref": "#/components/schemas/PermissionSet_b010baad" }, "condition": { "type": "string", "example": "context.myAttribute < 5" }, "ibxLocationCondition": { "$ref": "#/components/schemas/IbxLocationCondition" } }, "additionalProperties": false, "type": "object", "required": [ "permissionSet" ], "description": "A reference to a permission set, with optional conditions.\n Accepts a PermissionSetId (\"permissionset:...\"), ManagedPermissionSetId\n (\"managedset:...\"), or a local permission-set ERN with resource-type\n PermissionSet or ManagedPermissionSet. Foreign permission-set ERNs are\n not supported; use ForeignAccessPolicyRef instead." }, "PermissionsItem_9c975b94": { "properties": { "foreignAccessPolicy": { "$ref": "#/components/schemas/ForeignAccessPolicy" }, "condition": { "type": "string", "example": "context.myAttribute < 5" }, "ibxLocationCondition": { "$ref": "#/components/schemas/IbxLocationCondition" } }, "additionalProperties": false, "type": "object", "required": [ "foreignAccessPolicy" ], "description": "A reference to a foreign access policy ERN, with optional conditions.\n The :foreign-access-policy value must be an AccessPolicy ERN (not a\n permission set ERN)." }, "PermissionsItem_d242c415": { "properties": { "permissionSet": { "type": "string", "pattern": "^managedset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed permission set globally.", "example": "managedset:my-set" }, "condition": { "type": "string", "example": "context.myAttribute < 5" }, "ibxLocationCondition": { "$ref": "#/components/schemas/IbxLocationCondition" } }, "additionalProperties": false, "type": "object", "required": [ "permissionSet" ], "description": "A reference to a managed permission set, with optional conditions.\n This is the only permission entry form allowed in principal policies." }, "PermissionsItem_e119cb69": { "anyOf": [ { "$ref": "#/components/schemas/InlinePermission" }, { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, { "type": "string", "pattern": "^permissionset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a PermissionSet within a project.", "example": "permissionset:my-set" }, { "type": "string", "pattern": "^managedset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed permission set globally.", "example": "managedset:my-set" }, { "$ref": "#/components/schemas/PermissionsItem_9c975b94" }, { "$ref": "#/components/schemas/PermissionsItem_7d16b03e" } ] }, "Permissions_0c73f7d1": { "items": { "$ref": "#/components/schemas/PermissionsItem_e119cb69" }, "type": "array", "uniqueItems": true, "description": "A set of permissions, each of which may be an inline permission, a permission set reference,\n or a foreign access policy reference." }, "Permissions_9d45b317": { "items": { "properties": { "action": { "type": "string", "description": "Fully-qualified name of a Role Action", "example": "iam.role.assignment.read" }, "description": { "type": "string", "example": "Allows reading role assignments" } }, "type": "object", "required": [ "action", "description" ] }, "type": "array", "uniqueItems": true, "description": "List of permissions assigned to this role" }, "Permissions_be44d883": { "items": { "$ref": "#/components/schemas/PermissionsItem_d242c415" }, "type": "array", "uniqueItems": true }, "PhoneItem_405bab2a": { "type": "object", "properties": { "type": { "enum": [ "MOBILE", "OFFICE" ], "type": "string", "description": "Notification Type", "example": "MOBILE" }, "number": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "Phone number" }, "contactPreference": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone of the contact preference" }, "availability": { "enum": [ "WORK_HOURS", "ANYTIME" ], "type": "string", "description": "Availability of the contact preference" } }, "description": "Contact preference for the phone number" } } }, "PhoneItem_75f53845": { "type": "object", "properties": { "type": { "enum": [ "MOBILE", "OFFICE" ], "type": "string", "description": "Phone number type.", "example": "MOBILE" }, "number": { "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "description": "Phone number.", "example": "+14085551234" }, "contactPreference": { "type": "object", "properties": { "timezone": { "type": "string", "description": "Timezone.", "example": "PST" }, "availability": { "enum": [ "ANYTIME", "NEVER", "WORK_HOURS", "IBX_HOURS" ], "type": "string", "description": "Availability preference.", "example": "ANYTIME" } }, "description": "Cross Connect Contact Preference." } }, "description": "Contact phone number." }, "Phone_056c6ebf": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneItem_405bab2a" }, "description": "Array of contact phone numbers" }, "Phone_bb642f5d": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneItem_75f53845" }, "description": "Contact phone numbers." }, "PhysicalPorts": { "type": "array", "items": { "$ref": "#/components/schemas/DataItem_59eff7ff" }, "description": "Physical ports that implement this port" }, "PointOfContacts": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "SUPPORT" ], "type": "string", "description": "Contact Type", "example": "SUPPORT" }, "contacts": { "type": "array", "items": { "required": [ "email" ], "properties": { "name": { "type": "string" }, "role": { "type": "string" }, "email": { "type": "string" } } } } } }, "example": [ { "type": "SUPPORT", "contacts": [ { "name": "Peter Griffin", "role": "Vice President of Sales", "email": "example1@example.com" }, { "name": "Taylor Swift", "role": "Director of Marketing", "email": "example2@example.com" }, { "name": "Darth Vader", "role": "Head of Engineering", "email": "example3@example.com" } ] } ] }, "PolicyMaskId": { "description": "Uniquely identifies a policy mask globally or within a governing project.\nCallers may URL encode this value. When passing an ERN, callers *must* URL encode this value.", "anyOf": [ { "type": "string", "pattern": "^policymask:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a policy mask globally or within a governing project.", "example": "policymask:my-mask" }, { "$ref": "#/components/schemas/AccessPolicyId_542bc819" } ] }, "PortExpression": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/PortExpressions" }, "or": { "$ref": "#/components/schemas/PortExpressions" }, "property": { "$ref": "#/components/schemas/PortSearchFieldName", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id\n * `/settings/productCode` - Product Type CX\n * `/state` - Port Status ACTIVE\n" }, "operator": { "enum": [ "=", "!=", ">", ">=", "<", "<=", "LIKE", "ILIKE", "IN", "NOT IN", "BETWEEN" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "description": "Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time.\n" }, "PortExpressions": { "type": "array", "items": { "$ref": "#/components/schemas/PortExpression" } }, "PortSearchFieldName": { "enum": [ "/device/name", "/physicalPorts/tether/crossConnectId", "/physicalPorts/interface/name", "/state", "/project/projectId", "/uuid", "/name", "/account/orgId", "/account/accountNumber", "/location/metroCode", "/operation/maintenanceStatus", "/operation/lockEnabled" ], "type": "string", "description": "Possible field names to use on filters", "x-enum-deprecations": { "/device/name": true, "/physicalPorts/interface/name": true } }, "PortSortBy": { "enum": [ "/device/name", "/name", "/state", "/location/metroName", "/demarcationPointIbx", "/device/redundancy/priority", "/lagEnabled", "/physicalPortsSpeed", "/encapsulation/type", "/physicalPorts/tether/crossConnectId", "/package/code", "/changeLog/updatedDateTime", "/changeLog/createdDateTime", "/bandwidth", "/serviceCode", "/operation/maintenanceStatus" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/device/name" }, "PortSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/PortSortDirection" }, "property": { "$ref": "#/components/schemas/PortSortBy" } } }, "PortSortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "Port_9a46e395": { "type": "object", "properties": { "href": { "type": "string", "description": "url to entity", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix assigned Identifier", "format": "uuid" }, "type": { "type": "string", "description": "Type of Port" }, "cvpId": { "type": "integer", "description": "Customer virtual port Id" }, "bandwidth": { "type": "number", "description": "Port Bandwidth" }, "portName": { "type": "string", "description": "Port Name" }, "encapsulationProtocolType": { "type": "string", "description": "Port Encapsulation" }, "accountName": { "type": "string", "description": "Account Name" }, "priority": { "type": "string", "description": "Port Priority" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" } }, "description": "Configuration details for port used at the access point." }, "Port_f3a76199": { "type": "object", "properties": { "href": { "type": "string", "description": "Equinix assigned response attribute for an absolute URL that is the subject of the link's context.", "format": "uri" }, "type": { "enum": [ "XF_PORT" ], "type": "string", "description": "Type of Port" }, "id": { "type": "integer", "description": "Equinix assigned response attribute for Port Id" }, "uuid": { "type": "string", "description": "Equinix assigned response attribute for port identifier", "format": "uuid" }, "name": { "type": "string", "description": "Equinix assigned response attribute for Port name" }, "description": { "type": "string", "description": "Equinix assigned response attribute for Port description" }, "physicalPortsSpeed": { "minimum": 0.0, "type": "integer", "description": "Physical Ports Speed in Mbps" }, "connectionsCount": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Connection count" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "state": { "enum": [ "PENDING", "PROVISIONING", "REPROVISIONING", "PENDING_CROSS_CONNECT", "PROVISIONED", "ACTIVE", "DEPROVISIONING", "DEPROVISIONED", "INACTIVE", "FAILED", "ADDED", "DELETED", "TO_BE_ADDED", "TO_BE_DELETED" ], "type": "string", "description": "Port lifecycle state" }, "operation": { "$ref": "#/components/schemas/Operation_21b488ab" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "serviceType": { "enum": [ "EPL", "MSP" ], "type": "string", "description": "Port service Type" }, "serviceCode": { "enum": [ "CX", "IX", "IA", "MC" ], "type": "string", "description": "Identifies the service type associated with this port" }, "bandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port bandwidth in Mbps", "format": "int64" }, "availableBandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port available bandwidth in Mbps", "format": "int64" }, "usedBandwidth": { "minimum": 0.0, "type": "integer", "description": "Equinix assigned response attribute for Port used bandwidth in Mbps", "format": "int64" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "device": { "$ref": "#/components/schemas/Device_b2172721" }, "interface": { "type": "object", "properties": { "type": { "type": "string", "description": "Port interface type" } }, "description": "Port interface" }, "tether": { "$ref": "#/components/schemas/Tether" }, "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_970747e9" }, "redundancy": { "$ref": "#/components/schemas/Redundancy_616e679f" }, "encapsulation": { "type": "object", "properties": { "type": { "enum": [ "DOT1Q", "QINQ", "UNTAGGED" ], "type": "string", "description": "Port encapsulation protocol type" }, "tagProtocolId": { "type": "string", "description": "Port encapsulation tag protocol identifier" } }, "description": "Port encapsulation configuration" }, "lagEnabled": { "type": "boolean", "description": "If LAG enabled" }, "package": { "type": "object", "properties": { "code": { "enum": [ "STANDARD", "UNLIMITED", "UNLIMITED_PLUS" ], "type": "string", "description": "Type of Port Package" } }, "description": "Package settings for port" }, "settings": { "$ref": "#/components/schemas/Settings_10b6d98e" }, "physicalPortQuantity": { "type": "integer", "description": "Number of physical ports" }, "additionalInfo": { "type": "array", "items": { "properties": { "key": { "type": "string", "description": "Key" }, "value": { "type": "string", "description": "Value" } }, "description": "Additional information" }, "description": "Port additional information" }, "physicalPorts": { "$ref": "#/components/schemas/PhysicalPorts" } }, "description": "Port specification" }, "Port_fbde9407": { "required": [ "href", "type", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Port URI", "example": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd" }, "type": { "enum": [ "XF_PORT", "IA_PORT" ], "type": "string", "description": "Port type. XF - Fabric port, IA_PORT - Internet Access dedicated port", "example": "XF_PORT" }, "uuid": { "type": "string", "description": "Port identifier", "format": "uuid", "example": "a867f685-41b0-1b07-6de0-320a5c00abdd" } } }, "Ports": { "type": "array", "items": { "$ref": "#/components/schemas/PortsItem" } }, "PortsItem": { "required": [ "type", "uuid" ], "type": "object", "properties": { "type": { "enum": [ "XF_PORT", "IX_PORT" ], "type": "string" }, "uuid": { "type": "string", "format": "uuid", "example": "94662143-e21b-4098-bfcf-e9416f47eae1" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "sellerRegion": { "type": "string" }, "sellerRegionDescription": { "type": "string" }, "crossConnectId": { "type": "string" } }, "description": "Colo Access Point" }, "Power": { "type": "array", "items": { "required": [ "accountNumber", "ibx" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "135888" }, "ibx": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "description": "Power messages provide the latest power usage data at the circuit-level." }, "description": "List of power message type to subscribe" }, "PowerHierarchyNode": { "type": "object", "properties": { "levelType": { "enum": [ "ibx", "cage", "cabinet", "circuit" ], "type": "string", "description": "levelType indicates which level in the power hierarchy does the node belong to.", "example": "ibx" }, "levelValue": { "type": "string", "description": "ibx code, cage us id, cabinet us id, circuit number for levelType ibx, cage, cabinet, circuit resp.", "example": "XY1" }, "label": { "type": "string", "description": "ibx code, cage unique space id, cabinet unique space id, circuit label for levelType ibx, cage, cabinet, circuit resp.", "example": "XY1" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/PowerHierarchyNode" }, "description": "ibx, cage, cabinet nodes can have cage, cabinet and circuit, circuit nodes as children respectively." } } }, "PrecisionTimeOrder": { "title": "precisionTimeOrder", "type": "object", "properties": { "purchaseOrderNumber": { "type": "string", "description": "Purchase order number" }, "customerReferenceNumber": { "type": "string", "description": "Customer reference number" }, "orderNumber": { "type": "string", "description": "Order Reference Number" } }, "description": "Precision Time Order" }, "PrecisionTimePackagePostResponse": { "title": "precisionTimePackagePostResponse", "required": [ "code" ], "type": "object", "properties": { "href": { "type": "string", "format": "uri" }, "code": { "enum": [ "NTP_STANDARD", "NTP_ENTERPRISE", "PTP_STANDARD", "PTP_ENTERPRISE" ], "type": "string" } }, "example": { "href": "https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD", "code": "NTP_STANDARD" } }, "PrecisionTimePackageRequest": { "title": "precisionTimePackageRequest", "required": [ "code" ], "type": "object", "properties": { "code": { "enum": [ "NTP_STANDARD", "NTP_ENTERPRISE", "PTP_STANDARD", "PTP_ENTERPRISE" ], "type": "string", "description": "Precision Time Service Level" } }, "description": "Precision Time Service Level Request", "example": { "code": "NTP_STANDARD" } }, "PrecisionTimeServiceResponse": { "title": "precisionTimeServiceResponse", "required": [ "uuid", "href", "type", "state", "package" ], "type": "object", "properties": { "href": { "type": "string", "description": "Precision Time Service URI.", "format": "uri" }, "type": { "enum": [ "NTP", "PTP" ], "type": "string", "description": "Precision Time Service type refers to the corresponding protocol." }, "name": { "type": "string", "description": "Precision Time Service Name." }, "uuid": { "type": "string", "description": "Precision Time Service UUID.", "format": "uuid" }, "state": { "enum": [ "CANCELLED", "CANCELLING", "CONFIGURING", "CONFIGURING_FAILED", "DRAFT", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "PROVISIONED", "PROVISIONING", "PROVISIONING_FAILED", "REPROVISIONING", "REPROVISIONING_FAILED" ], "type": "string", "description": "Precision Time Service Status." }, "operation": { "type": "object", "properties": { "operationalStatus": { "enum": [ "UP", "DOWN", "DEGRADED" ], "type": "string", "description": "time service operational status" } }, "description": "time service operational data" }, "package": { "$ref": "#/components/schemas/PrecisionTimePackagePostResponse" }, "connections": { "$ref": "#/components/schemas/Connections_73eaa6a1" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_b8d452c8" }, "ntpAdvancedConfiguration": { "$ref": "#/components/schemas/NtpAdvancedConfiguration" }, "ptpAdvancedConfiguration": { "$ref": "#/components/schemas/PtpAdvancedConfiguration" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "order": { "$ref": "#/components/schemas/PrecisionTimeOrder" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" } }, "description": "Precision Time Service Response Schema.", "x-fastmcp-top-level-schema": "precisionTimeServiceResponse" }, "PrefixLength": { "maximum": 128.0, "minimum": 1.0, "type": "integer", "description": "The IPv6 routing prefix, sometimes called a subnet mask, is the network portion of an IP address. The prefix length is an integer between 1 and 128 (inclusive) that represents the number of bits set to 1, such as /24 or /60.", "format": "int32" }, "Prefix_bc7323fe": { "pattern": "^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$", "type": "string", "description": "Subnet prefix", "example": "2001:db8::/64" }, "Prefix_d1c3332c": { "pattern": "^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))$", "type": "string", "description": "Subnet prefix\n" }, "Price_cb97de4c": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit for this range, such as USD or DAYS.", "example": "USD" }, "min": { "type": "number", "description": "Minimum value for the range.", "format": "double", "example": 10 }, "max": { "type": "number", "description": "Maximum value for the range.", "format": "double", "example": 100 } }, "description": "Range details for price or delivery window." }, "Price_d4a7e5e4": { "title": "Price", "type": "object", "properties": { "amount": { "maximum": 999999999999999.0, "minimum": 0.0, "type": "number", "description": "Price" } }, "description": "The \"amount\" attribute denotes how much money the Purchase Order contains. This \"amount\" is measured in the currency type listed in the customer's account." }, "PricingDetails": { "type": "object", "properties": { "termLength": { "type": "string", "description": "The termlength of the Siebel order.", "example": "36" }, "orderNumber": { "type": "string", "description": "The order number.", "example": "1-198735018693" }, "core": { "type": "integer", "description": "The core selection on Siebel.", "example": 4 }, "throughput": { "type": "string", "description": "Throughput.", "example": "1" }, "throughputUnit": { "type": "string", "description": "The throughput unit.", "example": "Gbps" }, "packageCode": { "type": "string", "description": "The software package code.", "example": "AX" }, "additionalBandwidth": { "type": "string", "description": "The additional bandwidth selection on Siebel.", "example": "100" }, "primary": { "$ref": "#/components/schemas/Primary_9627f07d" }, "secondary": { "$ref": "#/components/schemas/Secondary_f7ab9bb6" } }, "description": "An object that has the pricing and other details of a Siebel order." }, "Pricing_Details": { "title": "Pricing Details", "type": "object", "properties": { "value": { "type": "number", "description": "To be used with `valueType` and `type`. Can be used to denote price or discount for an order or service", "example": "100" }, "valueType": { "enum": [ "ABSOLUTE", "PERCENTAGE" ], "type": "string", "description": "To indicate if `value` is of absolute or percentage value. i.e Use `ABSOLUTE` for $50 or `PERCENTAGE` for 50%" }, "type": { "enum": [ "ONE_TIME_CHARGE", "MONTHLY_CHARGE", "MONTHLY_DISCOUNT", "ONE_TIME_DISCOUNT", "NET_MONTHLY_CHARGE", "NET_ONE_TIME_CHARGE", "TAX" ], "type": "string", "description": "To indicate the type of `value` and `valueType." } }, "description": "Pricing details for a particular service or product. This can be of recurring and non-recurring charges. " }, "Primary_7adceb2c": { "type": "object", "properties": { "billingCommencementDateTime": { "type": "string", "description": "Billing commencement date.", "format": "date-time", "example": "2023-11-10T19:06:06Z" }, "billingEnabled": { "type": "boolean", "description": "Whether billing is enabled.", "example": true }, "charges": { "$ref": "#/components/schemas/Charges_26bcba3c" }, "currency": { "type": "string", "description": "Currency.", "example": "USD" } }, "description": "Pricing details response" }, "Primary_9627f07d": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the charges.", "example": "USD" }, "charges": { "$ref": "#/components/schemas/Charges_0805bf66" } }, "description": "An object that has the charges associated with the primary device." }, "Principal": { "anyOf": [ { "$ref": "#/components/schemas/Grantee_b325aced" }, { "type": "string", "pattern": "^group:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}:_?[a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9]+)?:.{1,200}$", "description": "Globally unique string identifier for a group formatted like \"group:...\".", "example": "group:abc-123:idp:my-group" } ], "description": "The principal assigned to a Role as provided in the `sub` claim of the access JWT" }, "PrivateServices": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string" } } }, "example": [ { "href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387", "uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387" }, { "href": "https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6", "uuid": "8a5685a6-063d-41ac-9279-d32431e8d8f6" } ] }, "ProcessSteps": { "maxItems": 3, "type": "array", "items": { "$ref": "#/components/schemas/ProcessStepsItem" } }, "ProcessStepsItem": { "type": "object", "properties": { "title": { "type": "string", "description": "Service profile custom step title" }, "subTitle": { "type": "string", "description": "Service profile custom step sub title" }, "description": { "type": "string", "description": "Service profile custom step description" } }, "description": "Definition of customized step while making connection" }, "ProductCatalogs": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCatalogsItem" }, "description": "Last-mile provider catalogs." }, "ProductCatalogsItem": { "type": "object", "properties": { "name": { "type": "string", "description": "Last-mile provider or catalog name.", "example": "att fiber" }, "id": { "type": "string", "description": "Last-mile provider or catalog identifier.", "example": "fc1eb018-df0a-4ee8-8dd1-e6b8ad61178d" }, "webUrl": { "type": "string", "description": "Last-mile catalog or provider website URL.", "example": "att.com/lastmile" }, "deliveryDate": { "$ref": "#/components/schemas/DeliveryDate" }, "billingTerms": { "type": [ "array", "null" ], "items": { "enum": [ 1, 12, 24, 36, 48, 60 ], "type": "integer" }, "description": "Available billing terms in months.", "example": [ 1, 12, 24, 36, 48, 60 ] }, "offerings": { "$ref": "#/components/schemas/Offerings" } }, "description": "Last-mile provider catalog details." }, "ProductOffering": { "type": "object", "properties": { "id": { "type": "string", "description": "Product offering identifier" }, "name": { "type": "string", "description": "Product offering name" }, "billingTerm": { "minimum": 1.0, "enum": [ 1, 12, 24, 36, 48, 60 ], "type": "integer", "description": "Billing term in months.", "example": 12 } }, "description": "Product offering for connection. Applicable to zSide only." }, "Products": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ProductsItem" }, "description": "Specification of services that the given LOA document is valid for." }, "ProductsItem": { "required": [ "crossConnect", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Product identifier.", "format": "uuid", "example": "535caeaf-bba4-46e0-99bc-bf39c72b275f" }, "type": { "enum": [ "CROSS_CONNECT" ], "type": "string", "description": "Product type", "example": "CROSS_CONNECT" }, "crossConnect": { "$ref": "#/components/schemas/CrossConnect" } }, "description": "Product interface" }, "Profile": { "type": "object", "properties": { "href": { "type": "string", "description": "Service Profile URI response attribute", "format": "uri" }, "type": { "enum": [ "L2_PROFILE", "L3_PROFILE", "IA_PROFILE", "IX_PROFILE", "IC_PROFILE", "LMAAS_PROFILE" ], "type": "string", "description": "Service profile type", "example": "L2_PROFILE", "x-eqx-api-linter-skip-rules": [ 40 ] }, "name": { "maxLength": 50, "type": "string", "description": "Customer-assigned service profile name", "example": "Sample Service Profile" }, "uuid": { "type": "string", "description": "Equinix-assigned service profile identifier", "format": "uuid" }, "description": { "type": "string", "description": "User-provided service description should be of maximum length 375", "example": "offering connectivity to my-network" }, "notifications": { "$ref": "#/components/schemas/Notifications_f30d1188" }, "tags": { "type": "array", "items": { "type": "string" } }, "visibility": { "enum": [ "PRIVATE", "PUBLIC" ], "type": "string" }, "allowedEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "accessPointTypeConfigs": { "$ref": "#/components/schemas/AccessPointTypeConfigs" }, "customFields": { "$ref": "#/components/schemas/CustomFields" }, "marketingInfo": { "$ref": "#/components/schemas/MarketingInfo" }, "ports": { "$ref": "#/components/schemas/Ports" }, "virtualDevices": { "$ref": "#/components/schemas/VirtualDevices" }, "metros": { "$ref": "#/components/schemas/Metros" }, "environments": { "$ref": "#/components/schemas/Environments" }, "selfProfile": { "type": "boolean", "description": "response attribute indicates whether the profile belongs to the same organization as the api-invoker." }, "projectId": { "type": "string" }, "lastMileConfig": { "$ref": "#/components/schemas/LastMileConfig" } }, "description": "Service Profile is a software definition for a named provider service and it's network connectivity requirements.\nThis includes the basic marketing information and one\nor more sets of access points (a set per each access point type) fulfilling the provider service.\n" }, "ProjectId_23abb2eb": { "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that accessPolicyId is an ERN.", "anyOf": [ { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" }, { "type": "string", "enum": [ "*" ], "title": "*", "description": "Indicates the resource is specified as an ERN in other input field." } ] }, "ProjectId_6fa8ff36": { "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that policyMaskId is an ERN.", "anyOf": [ { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" }, { "type": "string", "enum": [ "*" ], "title": "*", "description": "Indicates the resource is specified as an ERN in other input field." } ] }, "ProjectId_cef15e62": { "type": "string", "description": "Customer project Id. Check your projectId under Resource Management on Equinix Portal. You should have access to a project to see or create assets under it. Equinix will assign a projectId if you do not provide one.", "example": "XXXXX-XXXXXXXXXXX-XXXXXXXXXXX-XXXXXXXXXXXX" }, "ProjectId_db7dc4f4": { "description": "Globally unique identifier of a project.\nCallers may URL encode this value. Use `*` here to indicate that permissionSetId is an ERN.", "anyOf": [ { "type": "string", "pattern": "^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-9a-zA-Z-]{0,35}$", "description": "Globally unique identifier of a project.", "example": "project:abc-123" }, { "type": "string", "enum": [ "*" ], "title": "*", "description": "Indicates the resource is specified as an ERN in other input field." } ] }, "Project_12b4cec8": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } }, "description": "Project is optional for AM-CRH customers. If not provided, a default project will be assigned.", "example": "30ad25e2-53dc-11ed-bdc3-0242ac120002" }, "Project_812bd497": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" }, "href": { "type": "string", "description": "Project URI", "format": "uri", "example": "https://api.equinix.com/resourceManager/v1/projects/567" } } }, "Project_b02a33f1": { "required": [ "href", "projectId" ], "type": "object", "properties": { "href": { "type": "string", "description": "Project URI", "format": "uri", "example": "https://api.equinix.com/resourceManager/v1/projects/371" }, "projectId": { "type": "string", "description": "identifier of the project", "example": "9713123422221" }, "projectName": { "type": "string", "description": "name of the project", "example": "US Office" }, "parentOrganizationId": { "type": "string", "example": "22331" }, "parentOrganizationName": { "type": "string", "description": "Name of the parent organization", "example": "ABC Company" } } }, "Project_ddb4509d": { "required": [ "href", "parentOrganizationId", "parentOrganizationName", "projectId", "projectName" ], "type": "object", "properties": { "href": { "type": "string", "description": "Project URI", "format": "uri", "example": "https://api.equinix.com/resourceManager/v1/projects/371" }, "projectId": { "type": "string", "description": "identifier of the project", "example": "9713123422221" }, "projectName": { "type": "string", "description": "name of the project", "example": "US Office" }, "parentOrganizationId": { "type": "string", "example": "22331" }, "parentOrganizationName": { "type": "string", "description": "Name of the parent organization", "example": "ABC Company" } } }, "Property_10db7990": { "type": "string", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id\n * `/uuid` - App Domain uuid\n * `/name` - App Domain name\n * `/description` - App Domain description\n * `/state` - App Domain status\n * `/changeLog/createdDateTime` - App Domain creation timestamp\n * `/changeLog/updatedDateTime` - App Domain last updated timestamp\n * `/changeLog/deletedDateTime` - App Domain deletion timestamp\n", "example": "/name" }, "Property_13a1d620": { "enum": [ "/uuid", "/state", "/type", "/name", "/authorizedProductType", "/expirationDateTime", "/requestor/email", "/requestor/orgId", "/requestor/orgName", "/issuer/email", "/issuer/orgId", "/issuer/orgName", "/demarcationPoint/patchPanelId", "/demarcationPoint/patchPanelPortA", "/demarcationPoint/patchPanelPortB", "/demarcationPoint/connectorType", "/demarcationPoint/cageUniqueSpaceId", "/location/ibxCode", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on filters", "example": "/name" }, "Property_1e8cf171": { "type": "string", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id\n * `/uuid` - App Subscription uuid\n * `/state` - App Subscription status\n * `/source/appLink/uuid` - Source App Link uuid\n * `/source/ipSubnets` - Source App Link ip subnets\n * `/target/appService/uuid` - Target App Service uuid\n * `/target/geoScope` - Target App Service geo scope\n * `/target/prioritization` - Target App Service prioritization\n * `/changeLog/createdDateTime` - App Subscription creation timestamp\n * `/changeLog/updatedDateTime` - App Subscription last updated timestamp\n * `/changeLog/deletedDateTime` - App Subscription deletion timestamp\n", "example": "/name" }, "Property_59323f12": { "type": "string", "description": "Possible field names to use on filters:\n * `/name` - Service Profile name\n * `/uuid` - Service Profile uuid\n * `/state` - Service Profile status\n * `/metros/code` - Service Profile metro code\n * `/visibility` - Service Profile package\n * `/type` - Service Profile package\n * `/project/projectId` - Service Profile project id\n", "example": "/name" }, "Property_5dff40c1": { "type": "string", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id (mandatory)\n * `/name` - Precision Time Service name\n * `/uuid` - Precision Time Service uuid\n * `/type` - Precision Time Service protocol\n * `/state` - Precision Time Service status\n * `/account/accountNumber` - Precision Time Service account number\n * `/package/code` - Precision Time Service package\n * `/*` - all-category search\n", "example": "/name" }, "Property_6d8beca1": { "type": "string", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id\n * `/uuid` - App Service uuid\n * `/name` - App Service name\n * `/description` - App Service description\n * `/state` - App Service status\n * `/endpoint` - App Service endpoint\n * `/sourceDomains` - App Service source domains\n * `/changeLog/createdDateTime` - App Service creation timestamp\n * `/changeLog/updatedDateTime` - App Service last updated timestamp\n * `/changeLog/deletedDateTime` - App Service deletion timestamp\n", "example": "/name" }, "Property_776737e2": { "type": "string", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id\n * `/uuid` - App Processor uuid\n * `/name` - App Processor name\n * `/description` - App Processor description\n * `/state` - App Processor status\n * `/ipv4Subnet` - App Processor ipv4 subnet\n * `/bandwidth` - App Processor bandwidth\n * `/changeLog/createdDateTime` - App Processor creation timestamp\n * `/changeLog/updatedDateTime` - App Processor last updated timestamp\n * `/changeLog/deletedDateTime` - App Processor deletion timestamp\n", "example": "/name" }, "Property_b758e131": { "type": "string", "description": "Possible field names to use on filters:\n * `/uuid` - Subscription uuid\n * `/streamUuid` - Stream uuid the subscription belongs to\n * `/state` - Subscription state (`DEPROVISIONED` returned only when explicitly requested)\n * `/name` - Subscription name\n * `/project/projectId` - Subscription project id\n * `/description` - Subscription description\n * `/changeLog/createdDateTime` - Subscription created date time\n * `/changeLog/updatedDateTime` - Subscription updated date time\n", "example": "/streamUuid" }, "Property_bbafc745": { "enum": [ "/uuid", "/name", "/type", "/state", "/bmmrType", "/circuitId", "/serialNumber", "/redundancy/group", "/redundancy/priority", "/aSide/demarcationPoint/patchPanelId", "/aSide/demarcationPoint/patchPanelPortA", "/aSide/demarcationPoint/patchPanelPortB", "/aSide/location/ibxCode", "/zSide/demarcationPoint/patchPanelId", "/zSide/demarcationPoint/patchPanelPortA", "/zSide/demarcationPoint/patchPanelPortB", "/zSide/location/ibxCode", "/zSide/loa/uuid", "/account/accountNumber", "/order/orderNumber", "/order/customerReferenceId", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on filters.", "example": "/name" }, "Property_bf00e210": { "type": "string", "description": "Possible field names to use on filters:\n * `/type` - type of command\n * `/name` - name of command\n * `/state` - state of command\n * `/request/destination` - destination of command request\n * `/request/sourceConnection/uuid` - source connection uuid\n * `/*` - all-category search\n", "example": "/state" }, "Property_c6fb7fed": { "type": "string", "description": "Possible field names to use on filters:\n * `/type` - Route table entry type\n * `/prefix` - Route table entry prefix\n * `/nextHop` - Route table entry nextHop\n * `/state` - Route table entry state\n * `/MED` - Route table entry med\n * `/*` - all-category search\n", "example": "/type" }, "Property_c8297d68": { "type": "string", "description": "Possible field names to use on filters:\n * `/uuid` - Stream uuid\n * `/name` - Stream name\n * `/state` - Stream state (`DEPROVISIONED` returned only when explicitly requested)\n * `/type` - Stream type\n * `/description` - Stream description\n * `/project/projectId` - Stream project id\n * `/changeLog/createdDateTime` - Stream created date time\n * `/changeLog/updatedDateTime` - Stream updated date time\n", "example": "/name" }, "Property_c9ecba32": { "allOf": [ { "enum": [ "/name", "/uuid", "/tags/name", "/tags/uuid", "/tags/displayName", "/state", "/metros/metroCode", "/change/status" ], "type": "string", "description": "Searchable field names in company profile", "example": "/tags/name" } ], "description": "Searchable field name. Properties are grouped by their supported operators:\nString properties (support all operators):\n * `/name` - Company profile name\n * `/uuid` - Company profile UUID\n * `/tags/name` - Tag name\n * `/tags/uuid` - Tag UUID\n * `/tags/displayName` - Tag display name\n\nDiscrete value properties (only support `=`, `!=`, `IN`, `NOT IN`):\n * `/state` - Company profile state (`PENDING`, `PROVISIONED`, `DEPROVISIONED`, `REJECTED`)\n * `/metros/metroCode` - Metro code (e.g. `SV`, `NY`, `DC`)\n * `/change/status` - Change status (`PENDING`, `COMPLETED`, `REJECTED`) — seller and admin users only\n", "example": "/state" }, "Property_e48e02b3": { "type": "string", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id\n * `/uuid` - App Link uuid\n * `/name` - App Link name\n * `/description` - App Link description\n * `/state` - App Link status\n * `/ipv4Subnet` - App Link ipv4 subnet\n * `/bandwidth` - App Link bandwidth\n * `/changeLog/createdDateTime` - App Link creation timestamp\n * `/changeLog/updatedDateTime` - App Link last updated timestamp\n * `/changeLog/deletedDateTime` - App Link deletion timestamp\n", "example": "/name" }, "ProtocolTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolTypesItem" } }, "ProtocolTypesItem": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/Name_450fe5a4" }, "connectorTypes": { "type": "array", "items": { "enum": [ "BNC", "LC", "FC", "SC", "ST", "WIRE_WRAP", "RJ45", "E2000", "RJ11" ], "type": "string", "description": "Name of the connector type that corresponds with the connection service", "example": "LC" } } } }, "Provider": { "required": [ "contacts" ], "type": "object", "properties": { "contacts": { "$ref": "#/components/schemas/Contacts_be02ebcc" } }, "description": "Party contacts" }, "ProviderStatus": { "enum": [ "AVAILABLE", "DEPROVISIONED", "DEPROVISIONING", "FAILED", "NOT_AVAILABLE", "PENDING_APPROVAL", "PENDING_CONFIGURATION", "PROVISIONED", "PROVISIONING", "REJECTED", "PENDING_BGP", "ERROR", "ORDERING", "DELETING", "PENDING DELETE", "N/A", "QUOTING" ], "type": "string", "description": "Connection provider readiness status" }, "ProvisioningType": { "enum": [ "REGULAR", "FAST_PROVISIONING" ], "type": "string", "description": "If `REGULAR`, order will be provisioned as per standard lead time. If `FAST_PROVISIONING`, order is typically provisioned in 30min through the support of fast provisioning scheduling. However, service may be delayed due to system maintenance" }, "PtpAdvancedConfiguration": { "type": "object", "properties": { "timeScale": { "enum": [ "ARB", "PTP" ], "type": "string", "description": "Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol.", "example": "ARB" }, "domain": { "maximum": 127.0, "minimum": 0.0, "type": "integer", "description": "The PTP domain value.", "example": 0 }, "priority1": { "maximum": 248.0, "minimum": 0.0, "type": "integer", "description": "The priority1 value determines the best primary clock, Lower value indicates higher priority.", "example": 128 }, "priority2": { "maximum": 248.0, "minimum": 0.0, "type": "integer", "description": "The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.", "example": 128 }, "logAnnounceInterval": { "enum": [ -3, -2, -1, 0, 1 ], "type": "integer", "description": "Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second.", "example": 1 }, "logSyncInterval": { "enum": [ -5, -4, -3, -2, -1, 0, 1 ], "type": "integer", "description": "Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second..", "example": -4 }, "logDelayReqInterval": { "enum": [ -5, -4, -3, -2, -1, 0, 1 ], "type": "integer", "description": "Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second..", "example": -4 }, "transportMode": { "enum": [ "MULTICAST", "UNICAST", "HYBRID" ], "type": "string" }, "grantTime": { "maximum": 7200.0, "minimum": 30.0, "type": "integer", "description": "Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.", "example": 300 } }, "description": "PTP Advanced Configuration." }, "PublicKey": { "type": "string", "description": "The public key.", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tjom/BWDSU\\nGPl+nafzlHDTYW7hdI4yZ5ew18JH4JW9jbhUFrviQzM7xlELEVf4h9lFX5QVkbPppSwg0cda3\\nPbv7kOdJ/MTyBlWXFCR+HAo3FXRitBqxiX1nKhXpHAZsMciLq8V6RjsNAQwdsdMFvSlVK/7XA\\nt3FaoJoAsncM1Q9x5+3V0Ww68/eIFmb1zuUFljQJKprrX88Xypsamplesample" }, "PublicPeeringConnection": { "type": "object", "properties": { "type": { "type": "string", "description": "Connection type IX_VC", "format": "enum", "example": "IX_VC" }, "href": { "type": "string", "description": "URI", "format": "string", "example": "https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4" }, "uuid": { "type": "string", "description": "uuid", "format": "uuid", "example": "b44c6e6c-2c36-4488-b3f1-47064357b5b4" } } }, "PurchaseOrder_5185db24": { "required": [ "number" ], "type": "object", "properties": { "type": { "enum": [ "STANDARD_PURCHASE_ORDER", "BLANKET_PURCHASE_ORDER" ], "type": "string", "description": "Purchase order type" }, "number": { "type": "string", "description": "Purchase order number\n", "example": "129105284100" }, "amount": { "minimum": 1.0, "type": "number", "description": "Amount", "example": 100.5 }, "startDate": { "type": "string", "description": "Start date in YYYY-MM-DD format", "format": "date" }, "endDate": { "type": "string", "description": "End date in YYYY-MM-DD format", "format": "date" }, "description": { "maxLength": 4096, "type": "string", "description": "Purchase order description", "example": "example purchase order description" }, "attachment": { "type": "object", "properties": { "attachmentId": { "type": "string", "format": "uuid" } } } } }, "PurchaseOrder_6501a121": { "type": "object", "properties": { "number": { "type": "string", "description": "purchase order number" }, "amount": { "type": "string", "description": "purchase order amount" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "attachmentId": { "type": "string", "format": "uuid" }, "selectionType": { "enum": [ "EXEMPTION", "EXISTING", "NEW", "BLANKET" ], "type": "string" }, "type": { "enum": [ "EXEMPTION", "EXISTING", "NEW", "BLANKET" ], "type": "string" } }, "description": "Purchase Order information associate to the account" }, "PurchaseOrder_b7dda539": { "type": "object", "properties": { "number": { "type": "string", "description": "Purchase Order number.", "example": "1233" }, "amount": { "type": "string", "description": "Purchase Order amount.", "example": "10000" }, "startDate": { "type": "string", "description": "Date the Purchase Order takes effect.", "format": "date", "example": "2026-02-26" }, "endDate": { "type": "string", "description": "Date the Purchase Order expires.", "format": "date", "example": "2027-02-26" }, "attachmentId": { "type": "string", "description": "Identifier of the uploaded purchase order document.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "type": { "enum": [ "EXEMPTION", "EXISTING", "NEW" ], "type": "string", "description": "Purchase Order type.", "example": "NEW" } }, "description": "Purchase Order information associated with the account." }, "PurchaseOrder_d179fb3a": { "required": [ "type", "number" ], "type": "object", "properties": { "type": { "enum": [ "EXEMPTED", "NEW", "EXISTING" ], "type": "string", "description": "Type of the Purchase Order", "default": "EXEMPTED" }, "number": { "type": "string", "description": "Purchase order number is applicable when `type` is EXISTING or NEW" }, "amount": { "type": "number", "description": "This is only applicable when `type` is NEW", "example": "2020" }, "startDate": { "type": "string", "description": "This is only applicable when `type` is NEW", "format": "date", "example": "2020-05-22" }, "endDate": { "type": "string", "description": "This is only applicable when `type` is NEW", "format": "date", "example": "2021-05-22" }, "attachmentId": { "maxLength": 36, "minLength": 36, "type": "string", "description": "Attachment ID of Purchase Order document.", "example": "8d0bef9c-cca9-11ea-87d0-0242ac130003" } }, "description": "Purchase Order" }, "PurchaseOrder_dd8d6ac0": { "required": [ "href", "number", "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "Purchase Order URI", "example": "https://api.equinix.com/internetAccess/v1/purchaseOrders/32423423" }, "type": { "enum": [ "STANDARD_PURCHASE_ORDER", "BLANKET_PURCHASE_ORDER" ], "type": "string", "description": "Order type", "example": "STANDARD_PURCHASE_ORDER" }, "number": { "type": "string", "description": "Purchase Order number", "example": "32423423" } } }, "Purchase_Order_0d6c8f3e": { "title": "Purchase Order", "required": [ "purchaseOrderType" ], "type": "object", "properties": { "number": { "maxLength": 20, "type": "string", "description": "Purchase Order Number", "example": "123455" }, "purchaseOrderType": { "enum": [ "EXISTING", "EXEMPTED" ], "type": "string", "description": "Purchase Order Selection Type" } }, "description": "Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required" }, "Purchase_Order_eba003e3": { "title": "Purchase Order", "type": "object", "properties": { "startDate": { "type": "string", "description": "Purchase Order Start Date", "format": "date-time", "example": "2017-10-09T02:47:42.320Z" }, "endDate": { "type": "string", "description": "Purchase Order End Date", "format": "date-time", "example": "2017-10-10T02:47:42.320Z" }, "number": { "pattern": "^(.{1,30})$", "type": "string", "description": "Purchase Order Number", "example": "1-1234567890" }, "price": { "$ref": "#/components/schemas/Price_d4a7e5e4" } } }, "QuestionsItem": { "required": [ "answer", "type" ], "type": "object", "properties": { "type": { "enum": [ "PRIVATE_SPACE_CONSIDERED", "REFUSED_PREVIOUSLY", "RETURNING_ADDRESS_SPACE" ], "type": "string", "description": "Type of question relevant to requesting public IP Subnet\n", "example": "PRIVATE_SPACE_CONSIDERED" }, "answer": { "enum": [ "YES", "NO" ], "type": "string" } } }, "Questions_17431273": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionsItem" }, "description": "Connection of questions" }, "Questions_ad0e0bd4": { "type": "array", "items": { "$ref": "#/components/schemas/QuestionsItem" }, "description": "Connection of questions\n" }, "RaAttachmentSortItem": { "type": "object", "properties": { "property": { "enum": [ "/type", "/uuid", "/attachmentStatus", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" } } }, "ReadinessDateTime_7610d1bd": { "type": "string", "description": "Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation.\n", "format": "date-time", "example": "2026-02-26T07:21:39Z" }, "ReadinessDateTime_b0151ae5": { "type": "string", "description": "Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation.\n", "format": "date-time", "example": "2026-08-23T07:21:39Z" }, "RecipientsItem": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the recipient", "example": "John" }, "lastName": { "type": "string", "description": "Last name of the recipient", "example": "Doe" }, "sms": { "$ref": "#/components/schemas/Sms" }, "email": { "$ref": "#/components/schemas/Sms" } }, "description": "A recipient to be notified when a power alert condition is met" }, "Redundancy_03b2b702": { "type": "object", "properties": { "group": { "type": "string", "description": "Redundancy group identifier (UUID of primary connection)" }, "priority": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Connection priority in redundancy group" }, "name": { "type": "string", "description": "Customer-provided name for the redundancy group" }, "description": { "type": "string", "description": "Customer-provided description for the redundancy group" } }, "description": "Connection redundancy configuration" }, "Redundancy_4c4282fd": { "required": [ "enabled", "group", "priority" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "defines if redundancy is enabled.", "example": true }, "priority": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "priority of a connection", "example": "PRIMARY" }, "group": { "type": "string", "description": "Group identifier", "format": "uuid", "example": "f53e34d4-1371-4750-ab83-6c3f2e8b2c43" } } }, "Redundancy_609c857f": { "allOf": [ { "$ref": "#/components/schemas/Redundancy_b237089f" } ], "description": "Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY.\n" }, "Redundancy_616e679f": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Access point redundancy" }, "group": { "type": "string", "description": "Port UUID of respective primary port" }, "priority": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Port priority in redundancy group" } }, "description": "Port redundancy configuration" }, "Redundancy_b237089f": { "type": "object", "properties": { "group": { "type": "string", "description": "Redundancy group identifier. When placing a diverse Cross Connect against an existing one, provide either this identifier or the serial number of the existing Cross Connect.\n", "example": "7cf39156-9dec-40f7-a254-9bb401342e83" }, "priority": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Priority within the redundancy group.", "example": "PRIMARY" } }, "description": "Cross Connect Redundancy." }, "Redundancy_e8c4a2d1": { "type": "object", "properties": { "priority": { "enum": [ "PRIMARY", "SECONDARY" ], "type": "string", "description": "Role within the diverse pair.
PRIMARY - first connection of the pair.
SECONDARY - the diverse connection on a separate path.\n", "example": "PRIMARY" }, "group": { "type": "string", "description": "Redundancy group identifier", "format": "uuid" } }, "description": "Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.\n" }, "Refresh_token": { "type": "string", "description": "The OAuth2 refresh token which could be used to retrieve a new access_token without user credentials. The refresh_token has a max validity of 60 days after which a new Access Token request must be made. Refresh token is Not returned for \"client_credentials\" grant type" }, "Regulations": { "required": [ "addressingPlans", "questions" ], "type": "object", "properties": { "addressingPlans": { "type": "array", "items": { "required": [ "purpose", "size" ], "type": "object", "properties": { "purpose": { "type": "string", "description": "purpose" }, "size": { "type": "integer", "description": "size", "format": "int32" } } }, "description": "List of addressing plans" }, "questions": { "required": [ "privateSpaceConsidered", "refusedPreviously", "returningAddressSpace" ], "type": "object", "properties": { "privateSpaceConsidered": { "type": "boolean" }, "refusedPreviously": { "type": "boolean" }, "returningAddressSpace": { "type": "boolean" } } } } }, "Report_393da5c2": { "title": "Report", "required": [ "reportId", "scheduledId", "createdBy", "createdDate", "startTime", "status", "numberOfAttempts", "parameters" ], "type": "object", "properties": { "reportId": { "type": "string", "description": "A unique UUID string denoting the id of the report entry", "format": "uuid" }, "scheduledId": { "type": "string", "description": "Scheduled Id for the report entry", "format": "uuid" }, "createdBy": { "type": "string", "description": "Person/Entity who created this entry first time" }, "createdDate": { "type": "string", "description": "Time when this entry was first created", "format": "date-time" }, "lastAccessedBy": { "type": "string", "description": "Person/Entity who accessed this entry last time" }, "lastAccessedDate": { "type": "string", "description": "Time when this entry was last accessed", "format": "date-time" }, "startTime": { "type": "string", "description": "Processing start time of the report", "format": "date-time" }, "endTime": { "type": "string", "description": "Processing end time of the report", "format": "date-time" }, "status": { "title": "ReportStatus", "enum": [ "IN_PROGRESS", "DELAYED", "SUCCESS", "ERROR", "INACTIVE" ], "type": "string", "description": "Status of the report" }, "errorMessage": { "type": "string", "description": "Contains an error message if something is failed." }, "location": { "type": "string", "description": "Location of the report once it is generated" }, "numberOfDownloads": { "minimum": 0.0, "type": "integer", "description": "Number of times this report is downloaded by the customer", "default": 0 }, "numberOfAttempts": { "maximum": 3.0, "minimum": 0.0, "type": "integer", "description": "Number of times attempted to generate the report" }, "parameters": { "$ref": "#/components/schemas/Parameters_8d62e39d" }, "publisherInfo": { "type": "object", "description": "Contains report publish data as a json" } }, "example": { "reportId": "91b68c7a-e3d4-40ed-a048-e6ecb7c0a6af", "scheduledId": "5c66965a-f79b-46c5-a723-e13dae91e622", "createdBy": "minim aliquip sit", "createdDate": "3232-10-13T19:06:19.045Z", "lastAccessedBy": "mollit irure aliquip", "lastAccessedDate": "3454-08-17T05:56:04.691Z", "startTime": "3841-08-04T05:51:18.262Z", "endTime": "3907-11-27T08:16:24.458Z", "status": "ERROR", "errorMessage": "do Ex", "location": "dolore et fugiat", "numberOfDownloads": 18013697, "numberOfAttempts": 0, "parameters": [ { "name": "ex laborum", "value": "irure ex Lor", "type": "ARRAY" }, { "name": "magna Excepteur", "value": "sit", "type": "INT" }, { "name": "veniam mollit ea esse", "value": "non esse", "type": "BOOLEAN" }, { "name": "in elit veniam do", "value": "ipsum dolor", "type": "ARRAY" } ], "publisherInfo": {} } }, "Report_86ef4952": { "title": "Report", "required": [ "reportId", "scheduledId", "createdBy", "createdDate", "startTime", "status", "numberOfAttempts", "parameters" ], "type": "object", "properties": { "reportId": { "type": "string", "description": "A unique UUID string denoting the id of the report entry", "format": "uuid" }, "scheduledId": { "type": "string", "description": "Scheduled Id for the report entry", "format": "uuid" }, "createdBy": { "type": "string", "description": "Person/Entity who created this entry first time" }, "createdDate": { "type": "string", "description": "Time when this entry was first created", "format": "date-time" }, "lastAccessedBy": { "type": "string", "description": "Person/Entity who accessed this entry last time" }, "lastAccessedDate": { "type": "string", "description": "Time when this entry was last accessed", "format": "date-time" }, "startTime": { "type": "string", "description": "Processing start time of the report", "format": "date-time" }, "endTime": { "type": "string", "description": "Processing end time of the report", "format": "date-time" }, "status": { "title": "ReportStatus", "enum": [ "IN_PROGRESS", "DELAYED", "SUCCESS", "ERROR", "INACTIVE" ], "type": "string", "description": "Status of the report" }, "errorMessage": { "type": "string", "description": "Contains an error message if something is failed." }, "location": { "type": "string", "description": "Location of the report once it is generated" }, "numberOfDownloads": { "minimum": 0.0, "type": "integer", "description": "Number of times this report is downloaded by the customer", "default": 0 }, "numberOfAttempts": { "maximum": 3.0, "minimum": 0.0, "type": "integer", "description": "Number of times attempted to generate the report" }, "parameters": { "$ref": "#/components/schemas/Parameters_8d62e39d" }, "publisherInfo": { "type": "object", "description": "Contains report publish data as a json" } }, "example": { "reportId": "91b68c7a-e3d4-40ed-a048-e6ecb7c0a6af", "scheduledId": "5c66965a-f79b-46c5-a723-e13dae91e622", "createdBy": "minim aliquip sit", "createdDate": "3232-10-13T19:06:19.045Z", "lastAccessedBy": "mollit irure aliquip", "lastAccessedDate": "3454-08-17T05:56:04.691Z", "startTime": "3841-08-04T05:51:18.262Z", "endTime": "3907-11-27T08:16:24.458Z", "status": "ERROR", "errorMessage": "do Ex", "location": "dolore et fugiat", "numberOfDownloads": 18013697, "numberOfAttempts": 0, "parameters": [ { "name": "ex laborum", "value": "irure ex Lor", "type": "ARRAY" }, { "name": "magna Excepteur", "value": "sit", "type": "INT" }, { "name": "veniam mollit ea esse", "value": "non esse", "type": "BOOLEAN" }, { "name": "in elit veniam do", "value": "ipsum dolor", "type": "ARRAY" } ], "publisherInfo": {} }, "x-fastmcp-top-level-schema": "report" }, "Reports": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/components/schemas/Report_393da5c2" }, "description": "Array of generated reports" }, "Request": { "type": "object", "properties": { "destination": { "type": "string", "description": "Fabric Cloud Router Ping or Traceroute Command Destination", "example": "8.8.8.8" }, "sourceConnection": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Connection UUID", "example": "557400f8-d360-11e9-bb65-2a2ae2dbcce4" } }, "description": "Connection object for Cloud Router Command" }, "timeout": { "type": "integer", "description": "Timeout in seconds for Fabric Cloud Router Command:\n - For `PING_COMMAND`: Packet timeout duration. The default value is 5.\n - For `TRACEROUTE_COMMAND`: Probe timeout duration.\n The default value is 2 and it is not configurable.\n", "example": 2 }, "dataBytes": { "maximum": 9000.0, "minimum": 16.0, "type": "integer", "description": "Ping Command DataBytes. \nThis field is only applicable for commands of type `PING_COMMAND`.\n", "default": 64, "example": 100 }, "interval": { "type": "integer", "description": "Time in milliseconds between sending each packet.\nThis field is only applicable for commands of type `PING_COMMAND`.\n", "default": 1000, "example": 1000 }, "count": { "type": "integer", "description": "Total number of ping requests.\nThis field is only applicable for commands of type `PING_COMMAND`.\n", "default": 5, "example": 5 }, "probes": { "type": "integer", "description": "Number of probes for Fabric Cloud Router Traceroute Command.\nThis field is only applicable for commands of type `TRACEROUTE_COMMAND` and is not configurable.\n", "default": 3, "example": 3 }, "hopsMax": { "maximum": 30.0, "type": "integer", "description": "Maximum number of hops for the traceroute command.\nThis field is only applicable for commands of type `TRACEROUTE_COMMAND`.\n", "default": 20, "example": 20 } }, "description": "Fabric Cloud Router Command Request" }, "Requestor": { "type": "object", "properties": { "email": { "type": "string", "description": "Email address of the requestor contact.", "format": "email", "example": "user@org1.com" }, "orgId": { "type": "integer", "description": "Organization ID of the requestor.", "example": 9257 }, "orgName": { "type": "string", "description": "Organization name of the requestor.", "example": "ABC Inc." } }, "description": "Requestor" }, "ResourceSelector_30b32894": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" }, "description": "### Supported metric names to use on filters with property /subject:\n * `/fabric/v4/ports/` - port metrics\n * `/fabric/v4/connections/` - connection metrics\n * `/fabric/v4/metros/` - metro latency metrics\n" } } }, "ResourceSelector_b024e7f3": { "required": [ "include" ], "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" }, "description": "### Supported metric names to use on filters with property /subject:\n * `/fabric/v4/ports/` - port metrics\n * `/fabric/v4/connections/` - connection metrics\n * `/fabric/v4/metros/` - metro latency metrics\n" } } }, "Resource_5c92ca19": { "type": "object", "properties": { "href": { "type": "string", "description": "Cloud Event asset href" }, "uuid": { "type": "string", "description": "Cloud Event asset uuid" }, "type": { "type": "string", "description": "Cloud Event asset type" }, "name": { "type": "string", "description": "Cloud Event asset name" }, "state": { "type": "string", "description": "Cloud Event asset state" }, "operation": { "type": "object", "properties": { "operationalStatus": { "type": "string", "description": "Operational status for the resource target of the event" } } } } }, "Resource_6fef64a2": { "type": "object", "properties": { "href": { "type": "string", "description": "Metric resource href" }, "uuid": { "type": "string", "description": "Metric resource UUID" }, "type": { "type": "string", "description": "Metric resource type" }, "state": { "type": "string", "description": "Metric resource state" }, "name": { "type": "string", "description": "Metric resource name" }, "description": { "type": "string", "description": "Metric resource description" } }, "description": "Metric resource" }, "Resources_2ee19373": { "items": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "type": "array", "uniqueItems": true, "title": "Resources" }, "Resources_31826c88": { "anyOf": [ { "type": "string", "enum": [ "all" ], "title": "All" }, { "$ref": "#/components/schemas/Resources_2ee19373" } ] }, "Response_1421a8cf": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/Response_99d97393" }, { "$ref": "#/components/schemas/Response_8a2fba41" } ] }, "Response_8a2fba41": { "type": "object", "properties": { "output": { "type": "string" }, "outputStructuredTraceroute": { "$ref": "#/components/schemas/OutputStructuredTraceroute" }, "errors": { "$ref": "#/components/schemas/Errors_a7ba79b3" } } }, "Response_99d97393": { "type": "object", "properties": { "output": { "type": "string" }, "outputStructuredPing": { "$ref": "#/components/schemas/OutputStructuredPing" }, "errors": { "$ref": "#/components/schemas/Errors_a7ba79b3" } } }, "Restores": { "type": "array", "items": { "$ref": "#/components/schemas/RestoresItem" } }, "RestoresItem": { "type": "object", "properties": { "uuid": { "type": "string", "description": "The unique Id of a backup.", "example": "7hgj5675-5c3f-4275-adba-0c9e3c26c45y" }, "status": { "enum": [ "COMPLETED", "FAILED", "IN_PROGRESS" ], "type": "string", "description": "The status of the backup.", "example": "COMPLETED" }, "createdBy": { "type": "string", "description": "Created by.", "example": "cust0001" }, "createdDateTime": { "type": "string", "description": "Created date.", "format": "date-time", "example": "2018-01-30T10:30:31Z" }, "lastUpdatedDateTime": { "type": "string", "description": "Last updated date.", "format": "date-time", "example": "2018-01-30T10:30:31Z" } } }, "ResultItem": { "type": "object", "properties": { "name": { "enum": [ "COAX", "MP4_CABLE", "MULTI_MODE_FIBER", "POTS", "SINGLE_MODE_FIBER", "UTP" ], "type": "string", "description": "The name of the available connection service.", "example": "SINGLE_MODE_FIBER" }, "mediaTypes": { "$ref": "#/components/schemas/MediaTypes" } } }, "Result_0b57c25e": { "properties": { "accountId": { "type": "string", "description": "Billing account ID.", "example": "C-12345" }, "accountNumber": { "type": "string", "description": "Billing account number.", "example": "12345" }, "accountName": { "type": "string", "description": "Billing account name.", "example": "Equinix" }, "currency": { "type": "string", "description": "Billing account currency.", "example": "USD" }, "billingCountry": { "type": "string", "description": "Billing account country.", "example": "US" }, "accountStatus": { "enum": [ "ACTIVE", "PENDING_SIGNATURE", "CREDIT_HOLD", "IN_PROGRESS", "DECLINED" ], "type": "string", "description": "Billing account status", "example": "ACTIVE" }, "isGlobal": { "type": "boolean", "description": "Indicator for billing account type. true = Global billing account, false = Local billing account", "example": true }, "isPoRequired": { "type": "boolean", "description": "Indicator for pucharse order required.", "example": false }, "isSignatureRequired": { "type": "boolean", "description": "Indicator for signature required.", "example": false }, "isReseller": { "type": "boolean", "description": "Indicator for reseller.", "example": false }, "isSubCustomer": { "type": "boolean", "description": "Indicator for sub customer.", "example": false }, "createdDatetime": { "type": "string", "description": "Billing Account created datetime", "format": "date-time", "example": "2020-05-21T10:30:00+00:00" }, "lastModifiedDatetime": { "type": "string", "description": "Billing account last modified datetime", "format": "date-time", "example": "2020-05-23T12:30:00+00:00" } }, "x-fastmcp-top-level-schema": "BillingAccount" }, "Result_0d4cbadd": { "required": [ "bandwidth", "name", "type", "useCase" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Type_de450d9f" }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string", "description": "Service use case\n", "example": "MAIN" }, "name": { "type": "string", "description": "Name of the service instance\n", "example": "WebServers" }, "description": { "type": "string", "description": "Description of the service instance\n", "example": "Customer facing web servers\n" }, "bandwidth": { "type": "integer", "description": "Service bandwidth in Mbps\n", "example": 10000 }, "minBandwidthCommit": { "minimum": 0.0, "type": "integer", "description": "Service min bandwidth commit in Mbps\n", "example": 500 } } }, "Result_134b2236": { "type": "object", "properties": { "loa": { "type": "object", "properties": { "state": { "enum": [ "READY_FOR_USE", "LOCKED", "USED", "CANCELLED", "EXPIRED", "PENDING_REQUESTOR_ACCEPTANCE", "PENDING_PROVIDER_AUTHORIZATION" ], "type": "string", "description": "Digital LOA document status.", "example": "USED" } }, "description": "Digital LOA change result" } }, "description": "Change result" }, "Result_1fb444d6": { "required": [ "uuid", "billing", "draft", "state" ], "allOf": [ { "$ref": "#/components/schemas/Result_85c4ee33" }, { "$ref": "#/components/schemas/Result_d67821ff" } ], "x-fastmcp-top-level-schema": "Service" }, "Result_409dbcda": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] } } }, { "$ref": "#/components/schemas/Result_8d1d29b8" } ], "x-fastmcp-top-level-schema": "ServiceReadModel" }, "Result_85c4ee33": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, { "$ref": "#/components/schemas/Result_0d4cbadd" } ] }, "Result_89b7be4a": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "managedPermissionSets": { "$ref": "#/components/schemas/ManagedPermissionSets" }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "ern": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "disabledPolicy": { "enum": [ true ], "example": true }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "policyMaskId": { "type": "string", "pattern": "^policymask:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a policy mask globally or within a governing project.", "example": "policymask:my-mask" }, "managedPolicies": { "$ref": "#/components/schemas/ManagedPolicies" }, "subtract": { "$ref": "#/components/schemas/Subtract_d5f41db4" } }, "additionalProperties": false, "type": "object", "required": [ "tags", "policyMaskId", "rev", "ern" ] }, "Result_8d1d29b8": { "required": [ "account", "bandwidth", "billing", "billingEnabled", "change", "changeLog", "connections", "href", "locations", "name", "order", "project", "routingProtocol", "state", "type", "useCase", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "Internet access URI", "format": "uri", "example": "https://api.equinix.com/internetAccess/v1/services/2a4fb415-5a7f-436f-bae6-02f5e403deec" }, "uuid": { "type": "string", "description": "Service identifier", "format": "uuid", "example": "919ac898-a4b9-4f9d-b684-aa09ddc65b1b" }, "type": { "$ref": "#/components/schemas/Type_f2c412ba" }, "name": { "type": "string", "description": "Name of the service\nThis name should only contain spaces, the characters \"_\", \"-\", letters or numbers. The name cannot\nstart or end with a \"-\". This name can have only maximum of 24 characters\n", "example": "Internet Access" }, "description": { "type": "string", "description": "Description of the service", "example": "Internet access service" }, "bandwidth": { "minimum": 1000.0, "type": "integer", "description": "Bandwidth of the service in Mbps", "format": "int64", "example": 1000 }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "description": "Billing type of service", "example": "FIXED" }, "billingEnabled": { "type": "boolean", "description": "Indicates whether the service is billed" }, "billingStartDate": { "type": "string", "description": "Contains billing start date, if the service is billed", "format": "date" }, "state": { "enum": [ "PENDING", "PROVISIONING", "ACTIVE", "INACTIVE", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string" }, "change": { "$ref": "#/components/schemas/Change_36ac7b95" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "connections": { "$ref": "#/components/schemas/Connections_a8ffb32b" }, "routingProtocol": { "$ref": "#/components/schemas/RoutingProtocol_9f594f18" }, "locations": { "$ref": "#/components/schemas/Locations_8741feda" }, "account": { "$ref": "#/components/schemas/Account_2b85a339" }, "project": { "$ref": "#/components/schemas/Project_b02a33f1" }, "order": { "$ref": "#/components/schemas/Order_fb21beeb" }, "useCase": { "enum": [ "MAIN", "BACKUP", "MANAGEMENT_ACCESS" ], "type": "string" } } }, "Result_b74ae1ff": { "allOf": [ { "$ref": "#/components/schemas/Result_89b7be4a" }, {} ], "description": "A project-scoped policy mask controlling which managed policies and permission sets\n are available within a project.", "x-fastmcp-top-level-schema": "PolicyMask" }, "Result_d67821ff": { "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" }, "account": { "required": [ "accountNumber" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Billing account number\n", "example": "2-57689234" } } }, "billing": { "enum": [ "FIXED", "USAGE_BASED", "BURST_BASED" ], "type": "string", "description": "Type of billing\n", "default": "FIXED" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4755022f" }, "draft": { "type": "boolean", "default": false }, "links": { "$ref": "#/components/schemas/Links_8561166d" }, "order": { "required": [ "type" ], "allOf": [ { "allOf": [ { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "format": "uuid" } } } ] }, { "properties": { "type": { "enum": [ "NEW", "AMENDMENT" ], "type": "string" } } } ] }, "project": { "allOf": [ { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" } } }, { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Customer Resource Hierarchy Project identifier\n", "example": "7348" } } } ] }, "state": { "enum": [ "DRAFT", "PENDING", "PROVISIONING", "ACTIVE", "INACTIVE", "DEPROVISIONING", "DEPROVISIONED", "FAILED" ], "type": "string" } } }, "RfAttachmentSortItem": { "type": "object", "properties": { "property": { "enum": [ "/type", "/uuid", "/direction", "/attachmentStatus", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" } } }, "RouteAggregationRuleAndExpression": { "type": "object", "properties": { "and": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RouteAggregationRuleExpression" } } }, "description": "AND expression containing multiple filter expressions" }, "RouteAggregationRuleExpression": { "anyOf": [ { "$ref": "#/components/schemas/RouteAggregationRuleAndExpression" }, { "$ref": "#/components/schemas/RouteAggregationRuleOrExpression" }, { "$ref": "#/components/schemas/RouteAggregationRuleSimpleExpression" } ], "description": "Filter expression that can be AND, OR, or a simple expression" }, "RouteAggregationRuleOrExpression": { "type": "object", "properties": { "or": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RouteAggregationRuleExpression" } } }, "description": "OR expression containing multiple filter expressions" }, "RouteAggregationRuleSimpleExpression": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/type` - Route Aggregation Rules Type\n * `/name` - Route Aggregation Rules Name\n * `/uuid` - Route Aggregation Rules uuid\n * `/state` - Route Aggregation Rules status\n * `/prefix` - Route Aggregation Rule Prefix\n", "example": "/name" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `[NOT] LIKE` - (not) like\n * `[NOT] IN` - (not) in\n * `ILIKE` - case-insensitive like\n", "example": "=" }, "values": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "type": "string", "example": "Route_Aggregation_Rule_Demo" } } }, "description": "Simple filter expression with property, operator, and values" }, "RouteAggregationRuleSortBy": { "enum": [ "/type", "/uuid", "/name", "/state", "/prefix", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "RouteAggregationRuleSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/RouteAggregationRuleSortDirection" }, "property": { "$ref": "#/components/schemas/RouteAggregationRuleSortBy" } } }, "RouteAggregationRuleSortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "RouteAggregationRulesFilter": { "anyOf": [ { "$ref": "#/components/schemas/RouteAggregationRuleAndExpression" }, { "$ref": "#/components/schemas/RouteAggregationRuleOrExpression" } ], "description": "Top-level filter that can be either an AND expression or OR expression" }, "RouteAggregationSortBy": { "enum": [ "/type", "/uuid", "/name", "/project/projectId", "/state", "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/changeLog/deletedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "RouteAggregationSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/RouteAggregationSortDirection" }, "property": { "$ref": "#/components/schemas/RouteAggregationSortBy" } } }, "RouteAggregationSortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "RouteCollector": { "type": "object", "properties": { "asn": { "type": "integer", "description": "Route Collector ASN", "format": "int64", "example": 1238 }, "ipV4": { "type": "string", "description": "Route Collector ipV4 address", "example": "206.126.239.250/22" }, "ipV6": { "type": "string", "description": "Route Collector ipV6 address", "example": "2001:504:0:2:0:6:5517:1/64" } }, "description": "Route Collector" }, "RouteFilterRuleAndExpression": { "type": "object", "properties": { "and": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RouteFilterRuleExpression" } } }, "description": "AND expression containing multiple filter expressions" }, "RouteFilterRuleExpression": { "anyOf": [ { "$ref": "#/components/schemas/RouteFilterRuleAndExpression" }, { "$ref": "#/components/schemas/RouteFilterRuleOrExpression" }, { "$ref": "#/components/schemas/RouteFilterRuleSimpleExpression" } ], "description": "Filter expression that can be AND, OR, or a simple expression" }, "RouteFilterRuleOrExpression": { "type": "object", "properties": { "or": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RouteFilterRuleExpression" } } }, "description": "OR expression containing multiple filter expressions" }, "RouteFilterRuleSimpleExpression": { "type": "object", "properties": { "property": { "type": "string", "description": "Possible field names to use on filters:\n * `/type` - Route Filter Rules Type\n * `/name` - Route Filter Rules Name\n * `/uuid` - Route Filter Rules uuid\n * `/state` - Route Filter Rules status\n * `/prefix` - Route Filter Rule Prefix\n * `/prefixMatch` - Route Filter Rule Prefix Match\n", "example": "/name" }, "operator": { "type": "string", "description": "Possible operators to use on filters:\n * `=` - equal\n * `!=` - not equal\n * `[NOT] LIKE` - (not) like\n * `[NOT] IN` - (not) in\n * `ILIKE` - case-insensitive like\n", "example": "=" }, "values": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "type": "string", "example": "Route_Filter_Rule_Demo" } } }, "description": "Simple filter expression with property, operator, and values" }, "RouteFilterRuleSortBy": { "enum": [ "/type", "/uuid", "/name", "/state", "/prefix", "/prefixMatch", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "RouteFilterRuleSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/RouteFilterRuleSortDirection" }, "property": { "$ref": "#/components/schemas/RouteFilterRuleSortBy" } } }, "RouteFilterRuleSortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "RouteFilterRulesFilter": { "anyOf": [ { "$ref": "#/components/schemas/RouteFilterRuleAndExpression" }, { "$ref": "#/components/schemas/RouteFilterRuleOrExpression" } ], "description": "Top-level filter that can be either an AND expression or OR expression" }, "RouteFilterSortBy": { "enum": [ "/type", "/uuid", "/name", "/project/projectId", "/state", "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/changeLog/deletedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "RouteFilterSortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/RouteFilterSortDirection" }, "property": { "$ref": "#/components/schemas/RouteFilterSortBy" } } }, "RouteFilterSortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "Router_2239ca95": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Router UUID", "example": "a1c6b7fd-aead-410a-96b4-b1dfa1071700" }, "href": { "type": "string", "example": "https://api.equinix.com/fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700" }, "type": { "enum": [ "XF_ROUTER" ], "type": "string" }, "operation": { "$ref": "#/components/schemas/Operation_b2cbabaa" } }, "description": "Router object for router actions" }, "Router_6252121a": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Fabric_createCloudRouterResult_63f39c25" } ], "properties": { "href": { "type": "string", "description": "Cloud Routers URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "uuid": { "type": "string", "description": "Equinix-assigned access point identifier", "format": "uuid", "example": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170" }, "name": { "type": "string", "description": "Customer-provided Cloud Router name", "format": "string", "example": "test-fg-1" }, "state": { "enum": [ "PROVISIONED", "PROVISIONING", "DEPROVISIONING", "DEPROVISIONED", "REPROVISIONING", "NOT_PROVISIONED", "NOT_DEPROVISIONED" ], "type": "string", "description": "Access point lifecycle state", "example": "PROVISIONED" }, "equinixAsn": { "type": "integer", "description": "Equinix ASN", "format": "int64", "example": 30000 }, "connectionsCount": { "minimum": 0.0, "type": "integer", "description": "Number of connections associated with this Access point" }, "marketplaceSubscription": { "$ref": "#/components/schemas/MarketplaceSubscription" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "change": { "$ref": "#/components/schemas/Change_3a596f52" } }, "description": "Fabric Cloud Router object" }, "Router_81684de7": { "type": "object", "properties": { "href": { "type": "string", "description": "Resource URI", "format": "uri", "example": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6", "x-order": 1 }, "type": { "enum": [ "XF_ROUTER" ], "type": "string", "description": "Cloud Router Type", "example": "XF_ROUTER", "x-order": 2 }, "uuid": { "type": "string", "description": "Cloud Router UUID", "format": "uuid", "example": "36204584-2ae1-44f6-980f-08ecd555d9c6", "x-order": 3 } }, "description": "App Link Cloud Router", "x-order": 7 }, "RoutingProtocol_2bf9028a": { "allOf": [ { "$ref": "#/components/schemas/RoutingProtocol_84aa8287" }, { "required": [ "type" ], "properties": { "type": { "type": "string", "default": "STATIC" } } } ], "required": [ "type" ] }, "RoutingProtocol_3cbb1e72": { "required": [ "type", "customerRoutes", "connections" ], "type": "object", "properties": { "type": { "enum": [ "BGP", "DIRECT", "STATIC" ], "type": "string", "x-enum-varnames": [ "BGP", "DIRECT", "STATIC" ] }, "customerRoutes": { "type": "array", "items": { "type": "object", "properties": { "ipBlock": { "required": [ "href", "uuid" ], "type": "object", "properties": { "href": { "type": "string", "description": "URI of the IP block", "format": "uri" }, "uuid": { "type": "string", "description": "Unique identifier for the IP block", "format": "uuid" } } } } } }, "connections": { "$ref": "#/components/schemas/Connections_1076dd05" } } }, "RoutingProtocol_5ccc5e68": { "allOf": [ { "$ref": "#/components/schemas/RoutingProtocol_84aa8287" }, { "$ref": "#/components/schemas/RoutingProtocol_e63c4149" }, { "required": [ "type" ], "properties": { "type": { "type": "string", "default": "BGP" } } } ], "required": [ "type" ] }, "RoutingProtocol_61df553d": { "type": "object", "properties": { "customerAsn": { "type": "integer", "description": "Customer Autonomous System Number (ASN)", "example": 1100 }, "macAddress": { "type": "string", "description": "MAC address of the customer interface", "example": "00:11:22:33:44:55" }, "vlan": { "type": "integer", "description": "VLAN ID", "format": "int64", "example": 3292 }, "routeServerAsn": { "type": "integer", "description": "Equinix Route Server ASN", "format": "int64", "example": 1100 }, "bgpIpv4": { "$ref": "#/components/schemas/BgpIpv4_282c75d4" }, "bgpIpv6": { "$ref": "#/components/schemas/BgpIpv4_282c75d4" }, "routeCollector": { "$ref": "#/components/schemas/RouteCollector" } } }, "RoutingProtocol_63596801": { "required": [ "name", "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "Routing protocol URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "uuid": { "type": "string", "description": "Routing protocol identifier", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "type": { "type": "string", "description": "Allowed values:\n- BGP\n- DIRECT\n- STATIC\n", "format": "^(BGP|DIRECT|STATIC)$" }, "name": { "type": "string", "description": "Name of the routing protocol instance.", "example": "WebServers Routes" }, "description": { "type": "string", "description": "Description of the routing protocol instance", "example": "Routes to customer facing web servers" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_5ecf1ff9" }, "ipv6": { "$ref": "#/components/schemas/Ipv6_25b12f91" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" } } }, "RoutingProtocol_84aa8287": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] } } }, { "$ref": "#/components/schemas/RoutingProtocol_63596801" } ] }, "RoutingProtocol_9b86deee": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Allowed values:\n- BGP\n- DIRECT\n- STATIC\n", "format": "^(BGP|DIRECT|STATIC)$" }, "name": { "type": "string", "description": "Name of the routing protocol instance.\n", "example": "WebServers Routes" }, "description": { "type": "string", "description": "Description of the routing protocol instance\n", "example": "Routes to customer facing web server\n" } } }, "RoutingProtocol_9f594f18": { "anyOf": [ { "$ref": "#/components/schemas/RoutingProtocol_f490ddac" }, { "$ref": "#/components/schemas/RoutingProtocol_2bf9028a" }, { "$ref": "#/components/schemas/RoutingProtocol_5ccc5e68" } ] }, "RoutingProtocol_9ff713bf": { "allOf": [ { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] } } }, { "$ref": "#/components/schemas/RoutingProtocol_9b86deee" } ] }, "RoutingProtocol_e63c4149": { "required": [ "customerAsn", "equinixAsn", "exportPolicy" ], "type": "object", "properties": { "customerAsn": { "maximum": 4294967295.0, "minimum": 0.0, "type": "integer", "description": "Autonomous System Number", "format": "int64", "example": 16220 }, "customerAsnRange": { "enum": [ "BITS_16", "BITS_32" ], "type": "string", "description": "Customer Autonomous System Number range", "x-enum-varnames": [ "BITS_16", "BITS_32" ] }, "equinixAsn": { "maximum": 4294967295.0, "minimum": 0.0, "type": "integer", "description": "Autonomous System Number", "format": "int64", "example": 16220 }, "bgpAuthenticationType": { "enum": [ "AUTH_KEY", "NONE" ], "type": "string", "description": "BGP authentication type" }, "exportPolicy": { "enum": [ "FULL", "DEFAULT", "FULL_DEFAULT", "PARTIAL" ], "type": "string", "description": "Denotes which routes should be advertised to the internet\n" } }, "description": "BGP routing protocol" }, "RoutingProtocol_f490ddac": { "allOf": [ { "$ref": "#/components/schemas/RoutingProtocol_84aa8287" }, { "required": [ "type" ], "properties": { "type": { "type": "string", "default": "DIRECT" } } } ], "required": [ "type" ] }, "RoutingProtocolsItem": { "required": [ "changeLog", "links", "name", "type" ], "type": "object", "properties": { "href": { "type": "string", "description": "Routing protocol URI", "format": "URI", "example": "https://api.equinix.com/internetAccess/v1/services/df043001-bf0a-446b-a48f-bcdcca68a9f3/routingProtocols/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "uuid": { "type": "string", "description": "Routing protocol identifier", "format": "uuid", "example": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81" }, "type": { "enum": [ "DIRECT", "STATIC", "BGP" ], "type": "string" }, "name": { "type": "string", "description": "Name of the routing protocol instance.", "example": "WebServers Routes" }, "description": { "type": "string", "description": "Description of the routing protocol instance", "example": "Routes to customer facing web servers" }, "ipv4": { "$ref": "#/components/schemas/Ipv4_c1a253f3" }, "ipv6": { "$ref": "#/components/schemas/Ipv6_f5b325b1" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_ea2ded3e" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "tag1", "tag2", "tag3" ] }, "links": { "$ref": "#/components/schemas/Links_8561166d" } } }, "ScheduleType": { "enum": [ "STANDARD", "EXPEDITED", "SCHEDULED_MAINTENANCE" ], "type": "string", "description": "STANDARD:
Choose this option and we will complete your request in the standard turnaround time pending install base readiness. Most requests are processed within 24 to 72 hours. Requests will be processed on a first come, first served basis unless they are expedited. RequestedStartDate and requestedCompletionDate ignored for standard scheduling

EXPEDITED: Choose this option and Equinix will prioritize your request and attempt to fulfill it as soon as reasonably possible. Additional fees may apply. RequestedCompletionDate is mandatory for expedite scheduling. RequestedStartDate is ignored for expedite scheduling.

SCHEDULED_MAINTENANCE: Choose this option to schedule a request for a specific date and time, including today. RequestedStartDate and requestedCompletionDate are mandatory for schedule maintenance" }, "Schedule_118f5655": { "allOf": [ { "$ref": "#/components/schemas/Schedule_5ccefd2c" } ], "description": "Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code.\n" }, "Schedule_5ccefd2c": { "required": [ "code" ], "type": "object", "properties": { "type": { "enum": [ "XC_INSTALL_SCHEDULE" ], "type": "string", "description": "Schedule type.", "example": "XC_INSTALL_SCHEDULE" }, "code": { "enum": [ "STANDARD", "FLEXIBLE", "EXPEDITE" ], "type": "string", "description": "Schedule Code.", "example": "STANDARD" }, "autoConvertToStandard": { "type": "boolean", "description": "Applicable only when the code is EXPEDITE. When true, Equinix schedules the Cross Connect as STANDARD when no EXPEDITE scheduling is available.\n", "example": true }, "readinessDateTime": { "$ref": "#/components/schemas/ReadinessDateTime_7610d1bd" }, "requestedDateTime": { "type": "string", "description": "Requested Installation Date and Time.", "format": "date-time", "example": "2026-02-27T07:21:39Z" } }, "description": "Cross Connect Installation Schedule." }, "Schedule_8b5845ab": { "allOf": [ { "$ref": "#/components/schemas/Schedule_9533c530" } ], "description": "Applicable for XC_DEINSTALL." }, "Schedule_9533c530": { "type": "object", "properties": { "href": { "type": "string", "description": "Schedule URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Schedule Identifier.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "type": { "enum": [ "XC_INSTALL_SCHEDULE", "XC_DEINSTALL_SCHEDULE" ], "type": "string", "description": "Sub-resource type.
XC_INSTALL_SCHEDULE - Installation schedule.
XC_DEINSTALL_SCHEDULE - Deinstallation schedule.\n", "example": "XC_INSTALL_SCHEDULE" }, "code": { "allOf": [ { "enum": [ "STANDARD", "FLEXIBLE", "EXPEDITE" ], "type": "string", "description": "Schedule Code.", "example": "STANDARD" } ] }, "state": { "allOf": [ { "enum": [ "PENDING", "COMPLETED", "FAILED", "CANCELLED", "PENDING_ACTION" ], "type": "string", "description": "Cross Connect Schedule State.", "example": "COMPLETED" } ] }, "autoConvertToStandard": { "type": "boolean", "description": "Indicates whether the Cross Connect is scheduled as STANDARD when no EXPEDITE scheduling is available. Returned only for EXPEDITE schedule.\n", "example": true }, "readinessDateTime": { "$ref": "#/components/schemas/ReadinessDateTime_b0151ae5" }, "requestedDateTime": { "type": "string", "description": "Requested Installation Date and Time.", "format": "date-time", "example": "2026-08-24T07:21:39Z" }, "equinixProposedDateTime": { "type": "string", "description": "Date and Time proposed by Equinix when the EXPEDITE schedule is not available.\n", "format": "date-time", "example": "2026-08-25T07:21:39Z" }, "installationDateTime": { "type": "string", "description": "Installation Date and Time.", "format": "date-time", "example": "2026-08-25T09:21:39Z" }, "deinstallationDateTime": { "type": "string", "description": "Deinstallation Date and Time. Returned for a removal schedule.", "format": "date-time", "example": "2026-09-16T17:21:25.586Z" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_a9aa0994" } }, "description": "Schedule of a Cross Connect." }, "Schedule_Info": { "title": "Schedule Info", "required": [ "scheduleType" ], "type": "object", "properties": { "scheduleType": { "$ref": "#/components/schemas/ScheduleType" }, "requestedStartDate": { "type": "string", "description": "Requested Start Date Time (ISO Date)
Cannot Past Date.", "format": "date-time", "example": "2017-04-05T12:00:00Z" }, "requestedCompletionDate": { "type": "string", "description": "Requested Completion Date Time (ISO Date)
Cannot Past Date.", "format": "date-time", "example": "2017-04-05T12:00:00Z" } }, "description": "Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited requests." }, "ScheduledReport": { "title": "ScheduledReport", "required": [ "scheduledId", "reportName", "scheduleType", "createdBy", "createdDate", "lastAttemptedDate", "customerOrganizationId", "status", "parameters", "reports" ], "type": "object", "properties": { "scheduledId": { "type": "string", "description": "A unique UUID string denoting the id of the scheduled entry", "format": "uuid" }, "reportName": { "minLength": 1, "type": "string", "description": "Name of the report" }, "scheduleType": { "title": "ScheduleType", "enum": [ "ONE_TIME", "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "ANNUALLY" ], "type": "string", "description": "Scheduling strategy for the report to be generated." }, "period": { "title": "Period", "enum": [ "1_DAY", "7_DAYS", "14_DAYS", "30_DAYS", "90_DAYS", "180_DAYS", "1_YEAR", "CUSTOM", "NONE" ], "type": "string", "description": "Date range which the report should be generated" }, "createdBy": { "type": "string", "description": "Person/Entity who created this entry first time" }, "createdDate": { "type": "string", "description": "Time when this entry was first created", "format": "date-time" }, "lastAttemptedDate": { "type": "string", "description": "Last attempted date to trigger the report generation", "format": "date-time" }, "customerOrganizationId": { "minimum": 0.0, "type": "integer", "description": "Customer Organization Id" }, "forOrg": { "minimum": 1.0, "type": "integer", "description": "Customer Org Id where report is generated on behalf of" }, "forUser": { "type": "string", "description": "User key where report is generated on behalf of" }, "lastModifiedBy": { "type": "string", "description": "Person/Entity who modified this entry last time" }, "lastModifiedDate": { "type": "string", "description": "Last modified date of this entry", "format": "date-time" }, "numberOfFailedAttempts": { "maximum": 3.0, "minimum": 0.0, "type": "integer", "description": "Number of times the generation of report were failed" }, "status": { "title": "ScheduleStatus", "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED" ], "type": "string", "description": "Scheduling Status" }, "parameters": { "$ref": "#/components/schemas/Parameters_8d62e39d" }, "reports": { "$ref": "#/components/schemas/Reports" } }, "example": { "scheduledId": "806f281c-6295-465e-bd41-04559d4d4960", "reportName": "my_report", "scheduleType": "WEEKLY", "period": "30_DAYS", "createdBy": "john.doe", "createdDate": "2017-05-14T00:40:59.790Z", "lastAttemptedDate": "2018-07-02T21:59:15.045Z", "customerOrganizationId": 44010, "forOrg": 28120, "forUser": 12354, "lastModifiedBy": "john.doe", "lastModifiedDate": "2017-07-02T21:59:15.045Z", "numberOfFailedAttempts": 0, "status": "ACTIVE", "parameters": [ { "name": "adipisicing", "value": "Duis", "type": "STRING" }, { "name": "esse anim dolor et", "value": "velit Excepteur voluptate", "type": "ARRAY" }, { "name": "exercitation pariatur cupidatat anim in", "value": "labore esse", "type": "ARRAY" }, { "name": "exercitation est", "value": "magna quis", "type": "DOUBLE" }, { "name": "dolor nulla nisi ut eu", "value": "Duis mollit Lorem", "type": "DOUBLE" } ], "reports": [ { "reportId": "71df1306-94f9-4cbd-b6b0-735098bf7f87", "scheduledId": "772e5b73-3814-4604-8ae9-6f3eef114132", "createdBy": "ea sint fugi", "createdDate": "3738-09-09T05:31:51.735Z", "startTime": "3990-09-01T03:46:44.797Z", "status": "SUCCESS", "numberOfAttempts": 3, "parameters": [], "publisherInfo": {}, "lastAccessedBy": "sunt eu aute" }, { "reportId": "cff3620a-e3d6-4206-a504-1758bd400501", "scheduledId": "4ad6048f-3fc4-4fb9-8b66-22fba0bd62f1", "createdBy": "ullamco amet nostrud sint", "createdDate": "2918-11-28T03:33:08.736Z", "startTime": "4808-02-16T12:09:15.960Z", "status": "INACTIVE", "numberOfAttempts": 3, "parameters": [ { "name": "cillum Duis ex cupidatat voluptate", "value": "Ut", "type": "INT" } ], "location": "laboris nostrud", "errorMessage": "qui Excepteur", "endTime": "4909-04-15T03:51:50.570Z", "numberOfDownloads": 14336105, "publisherInfo": {} }, { "reportId": "4dbd3bea-25f8-485c-b06e-e9c06883b0d7", "scheduledId": "e572e79e-0a56-4052-879f-427ecb40dc85", "createdBy": "cupidatat", "createdDate": "4434-04-25T17:09:55.402Z", "startTime": "4243-01-15T02:51:52.654Z", "status": "INACTIVE", "numberOfAttempts": 0, "parameters": [ { "name": "pariatur aliqua ullamco dolor et", "value": "nisi deserunt dolore", "type": "STRING" }, { "name": "dolore amet ad", "value": "proident tempor", "type": "LONG" } ], "lastAccessedBy": "dolore exercitat", "errorMessage": "co", "endTime": "5058-03-30T22:21:23.213Z" }, { "reportId": "bc77cee9-0142-4954-afea-002d333b6440", "scheduledId": "98d33b3c-675e-4f1e-bfa7-ffdcd7b0aa18", "createdBy": "tempor", "createdDate": "2280-02-21T19:11:10.988Z", "startTime": "3750-11-06T20:13:33.607Z", "status": "ERROR", "numberOfAttempts": 1, "parameters": [ { "name": "qui non minim ut", "value": "ullamco Ut pariatur ipsum", "type": "INT" }, { "name": "nulla laborum deserunt", "value": "in dolore culpa consequat", "type": "ARRAY" } ], "location": "dolor", "lastAccessedDate": "4752-10-18T16:02:21.842Z", "publisherInfo": {}, "lastAccessedBy": "sunt ipsu", "numberOfDownloads": 51428315 } ] }, "x-fastmcp-top-level-schema": "scheduledReport" }, "SearchAndExpression": { "required": [ "and" ], "type": "object", "properties": { "and": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SearchFilterExpression" } } } }, "SearchExpression": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/SearchExpressions" }, "or": { "$ref": "#/components/schemas/SearchExpressions" }, "property": { "type": "string" }, "operator": { "enum": [ "=", "!=", ">", ">=", "<", "<=", "BETWEEN", "NOT BETWEEN", "LIKE", "NOT LIKE", "IN", "NOT IN", "IS NOT NULL", "IS NULL" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "SearchExpressions": { "type": "array", "items": { "$ref": "#/components/schemas/SearchExpression" } }, "SearchField": { "type": "string", "description": "Possible field names to use on filters:\n * `/project/projectId` - project id (mandatory)\n * `/name` - Fabric Cloud Router name\n * `/uuid` - Fabric Cloud Router uuid\n * `/state` - Fabric Cloud Router status\n * `/location/metroCode` - Fabric Cloud Router metro code\n * `/location/metroName` - Fabric Cloud Router metro name\n * `/package/code` - Fabric Cloud Router package\n * `/type` - Fabric Cloud Router type\n * `/connectionsCount` - Fabric Cloud Router attached connections count\n * `/changeLog/createdDateTime` - Fabric Cloud Router creation timestamp\n * `/changeLog/updatedDateTime` - Fabric Cloud Router last updated timestamp\n * `/changeLog/deletedDateTime` - Fabric Cloud Router deletion timestamp\n * `/*` - all-category search\n", "example": "/name" }, "SearchFieldName": { "enum": [ "/isRemote", "/name", "/uuid", "/type", "/geoScope", "/account/orgId", "/aSide/accessPoint/account/accountName", "/aSide/accessPoint/account/accountNumber", "/aSide/accessPoint/router/uuid", "/aSide/accessPoint/interconnect/uuid", "/aSide/accessPoint/linkProtocol/vlanTagMin", "/aSide/accessPoint/linkProtocol/vlanTagMax", "/aSide/accessPoint/location/metroCode", "/aSide/accessPoint/location/metroName", "/aSide/accessPoint/name", "/aSide/accessPoint/port/uuid", "/aSide/accessPoint/port/name", "/aSide/accessPoint/type", "/aSide/accessPoint/virtualDevice/name", "/aSide/accessPoint/virtualDevice/uuid", "/aSide/serviceToken/uuid", "/bandwidth", "/change/status", "/changeLog/createdBy", "/changeLog/createdDateTime", "/changeLog/deletedBy", "/changeLog/deletedDateTime", "/changeLog/lastUpdatedBy", "/operation/equinixStatus", "/operation/providerStatus", "/operation/maintenanceStatus", "/operation/lockEnabled", "/project/projectId", "/redundancy/group", "/redundancy/priority", "/redundancy/name", "/redundancy/description", "/zSide/accessPoint/account/accountName", "/zSide/accessPoint/authenticationKey", "/zSide/accessPoint/linkProtocol/vlanTagMin", "/zSide/accessPoint/linkProtocol/vlanTagMax", "/zSide/accessPoint/location/metroCode", "/zSide/accessPoint/location/metroName", "/zSide/accessPoint/sellerRegion", "/zSide/accessPoint/name", "/zSide/accessPoint/port/uuid", "/zSide/accessPoint/network/uuid", "/zSide/accessPoint/port/name", "/zSide/accessPoint/profile/uuid", "/zSide/accessPoint/type", "/zSide/accessPoint/role", "/zSide/accessPoint/virtualDevice/name", "/zSide/accessPoint/virtualDevice/uuid", "/zSide/serviceToken/uuid", "/zSide/internetAccess/uuid", "/state" ], "type": "string", "description": "Possible field names to use on filters" }, "SearchFilter": { "description": "Top-level filter that can be either an AND expression or OR expression", "anyOf": [ { "$ref": "#/components/schemas/SearchAndExpression" }, { "$ref": "#/components/schemas/SearchOrExpression" } ] }, "SearchFilterExpression": { "description": "Filter expression that can be AND, OR, or a simple expression", "anyOf": [ { "$ref": "#/components/schemas/SearchAndExpression" }, { "$ref": "#/components/schemas/SearchOrExpression" }, { "$ref": "#/components/schemas/SearchSimpleExpression" } ] }, "SearchOrExpression": { "required": [ "or" ], "type": "object", "properties": { "or": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SearchFilterExpression" } } } }, "SearchSimpleExpression": { "required": [ "property", "operator", "values" ], "type": "object", "properties": { "property": { "type": "string" }, "operator": { "enum": [ "=", "!=", "IN", "NOT IN", "LIKE", "ILIKE", "BETWEEN", ">", ">=", "<", "<=", "~*" ], "type": "string", "description": "\"~*\" is a case-insensitive glob match, equivalent to ILIKE - the same single \"*\" wildcard, not POSIX regex - kept as its own operator only because existing callers already send it.\n", "example": "=", "x-enum-varnames": [ "EQUAL", "NOT_EQUAL", "IN", "NOT_IN", "LIKE", "ILIKE", "BETWEEN", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "CASE_INSENSITIVE_REGEX" ] }, "values": { "maxItems": 8, "minItems": 1, "type": "array", "items": { "type": "string" } } }, "description": "Simple filter expression with property, operator, and values" }, "SearchSort": { "type": "array", "items": { "$ref": "#/components/schemas/SearchSortItem" } }, "SearchSortItem": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "enum": [ "ASC", "DESC" ], "type": "string", "example": "ASC" }, "property": { "type": "string" } } }, "Secondary_20f9e0a2": { "required": [ "metroCode", "notifications", "virtualDeviceName" ], "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account number", "example": "10478398" }, "accountReferenceId": { "type": "string", "description": "Account reference ID", "example": "209805" }, "version": { "type": "string", "description": "You can only choose a version for the secondary device when adding a secondary device to an existing device.", "example": "16.09.03" }, "additionalBandwidth": { "type": "integer", "description": "Secondary additional bandwidth to be configured (in Mbps for HA). Default bandwidth provided is 15 Mbps.", "format": "int32", "example": 100 }, "licenseFileId": { "type": "string", "description": "License file ID", "example": "d6e21e0c-86dd-11e8-adc0-fa7ae01bbebc" }, "licenseToken": { "type": "string", "description": "License token", "example": "V74191621" }, "day0TextFileId": { "$ref": "#/components/schemas/Day0TextFileId" }, "metroCode": { "type": "string", "description": "Metro code", "example": "SV" }, "notifications": { "type": "array", "items": { "type": "string", "example": "test1@equinix.com" }, "description": "List of email addresses for notifications" }, "aclDetails": { "$ref": "#/components/schemas/AclDetails_90ec39be" }, "sshUsers": { "$ref": "#/components/schemas/SshUsers_d0c792af" }, "virtualDeviceName": { "type": "string", "description": "Virtual Device Name", "example": "Router1-c8000v" }, "hostNamePrefix": { "$ref": "#/components/schemas/HostNamePrefix" }, "siteId": { "type": "string", "description": "Site ID", "example": "12345" }, "systemIpAddress": { "type": "string", "description": "System IP address", "example": "192.168.2.5" }, "vendorConfig": { "$ref": "#/components/schemas/VendorConfig_9949fa91" }, "sshInterfaceId": { "type": "string", "description": "You may specify any available interface on the device as the sshInterfaceId. This field is only applicable to self-configured devices.", "example": "4" }, "smartLicenseUrl": { "type": "string", "description": "License URL. This field is only relevant for Ciso ASAv devices.", "example": "https://wwww.equinix.com" }, "cloudInitFileId": { "type": "string", "description": "The Id of a previously uploaded license or cloud_init file.", "example": "2d732d49-7a00-4839-aeca-8a2ff89da691" } }, "description": "Request to create a secondary HA device" }, "Secondary_f7ab9bb6": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the charges.", "example": "USD" }, "charges": { "$ref": "#/components/schemas/Charges_0805bf66" } }, "description": "An object that has the charges associated with the secondary device." }, "ServiceActions_14212407": { "properties": { "serviceId": { "type": "string", "pattern": "^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a-zA-Z0-9]{0,49}$", "description": "Fully qualified, universally unique id of a service. Starts with the NamespaceId. Formatted like\n \"service:<namespace>/<service>\".", "example": "service:equinix/sts" }, "actions": { "$ref": "#/components/schemas/Actions" } }, "additionalProperties": false, "type": "object", "required": [ "serviceId", "actions" ], "title": "ServiceActions" }, "ServiceActions_393383e5": { "anyOf": [ { "type": "string", "enum": [ "all" ], "title": "All" }, { "$ref": "#/components/schemas/ServiceActions_d708cf90" } ] }, "ServiceActions_d708cf90": { "items": { "$ref": "#/components/schemas/ServiceActions_14212407" }, "type": "array", "uniqueItems": true }, "ServiceProfiles": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "uuid": { "type": "string" }, "type": { "enum": [ "L2_PROFILE", "L3_PROFILE", "IA_PROFILE", "IX_PROFILE", "IC_PROFILE", "LMAAS_PROFILE" ], "type": "string", "description": "Service profile type", "example": "L2_PROFILE", "x-eqx-api-linter-skip-rules": [ 40 ] } } }, "example": [ { "href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387", "uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387", "type": "L2_PROFILE" } ] }, "ServiceToken": { "type": "object", "properties": { "type": { "enum": [ "VC_TOKEN", "EPL_TOKEN" ], "type": "string", "description": "Type of Service Token" }, "href": { "type": "string", "description": "An absolute URL that is the subject of the link's context.", "format": "uri" }, "expiry": { "type": "integer" }, "uuid": { "type": "string", "description": "Equinix-assigned service token identifier", "format": "uuid" }, "issuerSide": { "type": "string", "description": "information about token side" }, "name": { "type": "string", "description": "Customer-provided service token name" }, "description": { "type": "string", "description": "Customer-provided service token description" }, "expirationDateTime": { "type": "string", "description": "Expiration date and time of the service token.", "format": "date-time", "example": "2020-11-06T07:00:00Z" }, "connection": { "$ref": "#/components/schemas/Connection_dd127cea" }, "state": { "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "DELETED" ], "type": "string", "description": "Service token state" }, "notifications": { "$ref": "#/components/schemas/Notifications_9750afd0" }, "account": { "$ref": "#/components/schemas/Account_8518334f" }, "changelog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } }, "description": "Project is optional for AM-CRH customers. If not provided, a default project will be assigned." } }, "description": "Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets." }, "ServiceTokenSearchExpression": { "type": "object", "properties": { "and": { "$ref": "#/components/schemas/ServiceTokenSearchExpressions" }, "or": { "$ref": "#/components/schemas/ServiceTokenSearchExpressions" }, "property": { "$ref": "#/components/schemas/ServiceTokenSearchFieldName" }, "operator": { "enum": [ "=", "!=", "LIKE", "ILIKE", "<", ">", "<=", ">=", "IN", "NOT IN", "BETWEEN", "NOT BETWEEN" ], "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "ServiceTokenSearchExpressions": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTokenSearchExpression" } }, "ServiceTokenSearchFieldName": { "enum": [ "/uuid", "/state", "/name", "/project/projectId", "/type", "/expirationDateTime", "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/connection/aSide/accessPointSelectors/port/uuid", "/connection/zSide/accessPointSelectors/port/uuid" ], "type": "string", "description": "Possible field names to use on filters" }, "ServicesItem_82149230": { "type": "object", "properties": { "href": { "type": "string", "description": "Service URI.", "format": "uri", "example": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79" }, "uuid": { "type": "string", "description": "Service Identifier.", "format": "uuid", "example": "e41f485e-3094-42de-8797-0ef19a51df79" }, "type": { "$ref": "#/components/schemas/Type_d79564c4" }, "state": { "allOf": [ { "enum": [ "PENDING", "COMPLETED", "FAILED" ], "type": "string", "description": "Service status.", "example": "COMPLETED" } ] }, "device": { "$ref": "#/components/schemas/Device_50154345" }, "description": { "maxLength": 100, "type": "string", "description": "Additional notes captured for the service.", "example": "additional notes for patch equipment" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_a9aa0994" } }, "description": "Service ordered alongside the Cross Connect." }, "ServicesItem_c22f48ea": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Type_0aa3b340" }, "device": { "$ref": "#/components/schemas/Device_da0f16aa" }, "description": { "maxLength": 100, "type": "string", "description": "Additional notes for the service. Required for the XC_PATCH_EQUIPMENT service.\n", "example": "additional notes for patch equipment" } }, "description": "Service to order alongside the Cross Connect.
Send one entry per service.
device and description apply to the XC_PATCH_EQUIPMENT service only.\n" }, "Services_0030155b": { "type": "array", "items": { "$ref": "#/components/schemas/ServicesItem_82149230" }, "description": "Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall.\n" }, "Services_1cb13837": { "type": "array", "items": { "$ref": "#/components/schemas/ServicesItem_c22f48ea" }, "description": "Cross Connect Services." }, "Settings_10b6d98e": { "type": "object", "properties": { "buyout": { "type": "boolean" }, "viewPortPermission": { "type": "boolean" }, "placeVcOrderPermission": { "type": "boolean" }, "layer3Enabled": { "type": "boolean" }, "packageType": { "enum": [ "STANDARD", "UNLIMITED", "UNLIMITED_PLUS" ], "type": "string", "description": "Type of Port Package" } }, "description": "Port configuration settings" }, "Settings_212c2c73": { "type": "object", "properties": { "eventIndex": { "type": "string", "description": "event index" }, "metricIndex": { "type": "string", "description": "metric index" }, "source": { "type": "string", "description": "source" }, "applicationKey": { "type": "string", "description": "Application key" }, "eventUri": { "type": "string", "description": "event uri" }, "metricUri": { "type": "string", "description": "metric uri" }, "format": { "enum": [ "CLOUDEVENT", "OPENTELEMETRY" ], "type": "string", "description": "webhook message format", "default": "CLOUDEVENT" } }, "description": "Stream subscription sink settings" }, "Shipment_Order_Response": { "title": "Shipment Order Response", "required": [ "orderNumber" ], "type": "object", "properties": { "OrderReferenceId": { "type": "string", "description": "Order Reference Id" }, "orderNumber": { "type": "string", "description": "Order Number", "example": "1-108124419634" }, "Id": { "type": "string", "description": "Order Id" }, "SRNumber": { "type": "string", "description": "SR Number" } }, "x-fastmcp-top-level-schema": "shipment-order-response" }, "Signature_2cdb41af": { "type": "object", "properties": { "signatory": { "enum": [ "DELEGATE", "SELF", "ACCOUNT_SUPPORT" ], "type": "string", "description": "Port signature Type" }, "delegate": { "type": "object", "properties": { "firstName": { "type": "string", "description": "first name of delegate" }, "lastName": { "type": "string", "description": "last Name of delegate" }, "email": { "type": "string", "description": "email of delegate" } }, "description": "order delegate details" } }, "description": "Port signature details" }, "Signature_82273560": { "required": [ "signatory" ], "type": "object", "properties": { "signatory": { "enum": [ "SELF", "DELEGATE", "SUPPORT" ], "type": "string", "example": "SELF" }, "delegate": { "required": [ "email" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "description": "Email address that the signature request should be sent to in case of DELEGATE signature\n", "format": "email", "example": "cto@business.com" } } } } }, "Sink_2cb28b2c": { "type": "object", "properties": { "uri": { "type": "string", "description": "any publicly reachable http endpoint" }, "type": { "enum": [ "DATADOG", "DYNATRACE", "GOOGLE_PUBSUB", "PAGERDUTY", "SERVICENOW", "SLACK", "SPLUNK_HEC", "TEAMS", "WEBHOOK" ], "type": "string", "description": "destination type" }, "batchEnabled": { "type": "boolean", "description": "batch mode on/off", "example": false }, "batchSizeMax": { "type": "integer", "description": "maximum batch size" }, "batchWaitTimeMax": { "type": "integer", "description": "maximum batch waiting time" }, "credential": { "$ref": "#/components/schemas/Credential" }, "settings": { "$ref": "#/components/schemas/Settings_212c2c73" }, "host": { "type": "string", "description": "sink host" } }, "description": "Create Stream destination" }, "Sink_80fea9cf": { "required": [ "type" ], "type": "object", "properties": { "uri": { "type": "string", "description": "any publicly reachable http endpoint" }, "type": { "enum": [ "DATADOG", "DYNATRACE", "GOOGLE_PUBSUB", "PAGERDUTY", "SERVICENOW", "SLACK", "SPLUNK_HEC", "TEAMS", "WEBHOOK" ], "type": "string", "description": "destination type" }, "batchEnabled": { "type": "boolean", "description": "batch mode on/off", "example": false }, "batchSizeMax": { "type": "integer", "description": "maximum batch size" }, "batchWaitTimeMax": { "type": "integer", "description": "maximum batch waiting time" }, "credential": { "$ref": "#/components/schemas/Credential" }, "settings": { "$ref": "#/components/schemas/Settings_212c2c73" }, "host": { "type": "string", "description": "sink host" } }, "description": "Create Stream destination" }, "Smartview_getAlertsResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Data_1efc0515" }, "pagination": { "$ref": "#/components/schemas/Pagination_25a0752b" } }, "x-fastmcp-top-level-schema": "PaginatedResponseAlertReadModel" }, "Smartview_getCurrentTagPointResult": { "type": "object", "properties": { "payLoad": { "$ref": "#/components/schemas/PayLoad_da0f51e0" }, "status": { "$ref": "#/components/schemas/Status_7ce217c1" } }, "x-fastmcp-top-level-schema": "TagPointData" }, "Sms": { "type": "object", "properties": { "value": { "type": "string", "description": "The contact value (phone number for SMS, email address for email)", "example": "user@example.com" }, "enabled": { "type": "boolean", "description": "Whether this contact method is enabled for notifications", "example": true } }, "description": "A contact method (SMS or email) for alert notifications" }, "SoftwarePackage": { "type": "object", "properties": { "name": { "type": "string", "description": "Software package name", "example": "Security" }, "packageCode": { "type": "string", "description": "Software package code", "example": "SEC" }, "licenseType": { "enum": [ "BYOL", "Subscription" ], "type": "string", "description": "Software package license type", "example": "BYOL" }, "versionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/VersionDetails" }, "description": "List of software version details" } }, "description": "Software package details" }, "SortBy": { "enum": [ "/name", "/direction", "/aSide/accessPoint/name", "/aSide/accessPoint/type", "/aSide/accessPoint/account/accountName", "/aSide/accessPoint/location/metroName", "/aSide/accessPoint/location/metroCode", "/aSide/accessPoint/linkProtocol/vlanCTag", "/aSide/accessPoint/linkProtocol/vlanSTag", "/zSide/accessPoint/name", "/zSide/accessPoint/type", "/zSide/accessPoint/role", "/zSide/accessPoint/account/accountName", "/zSide/accessPoint/location/metroName", "/zSide/accessPoint/location/metroCode", "/zSide/accessPoint/linkProtocol/vlanCTag", "/zSide/accessPoint/linkProtocol/vlanSTag", "/zSide/accessPoint/authenticationKey", "/bandwidth", "/geoScope", "/uuid", "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/operation/equinixStatus", "/operation/providerStatus", "/operation/maintenanceStatus", "/redundancy/priority" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" }, "SortCriteria": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/SortDirection" }, "property": { "$ref": "#/components/schemas/SortBy" } } }, "SortDirection": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction", "default": "DESC" }, "SortItem_3c499a95": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/name", "/expirationDateTime", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } }, "SortItem_5289102a": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/changeLog/createdDateTime", "/changeLog/updatedDateTime", "/med", "/connection/name", "/type", "/prefix", "/nextHop" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/updatedDateTime" } } }, "SortItem_aedf91e4": { "type": "object", "properties": { "direction": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction.", "default": "DESC" }, "property": { "enum": [ "/name", "/state", "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting.", "default": "/changeLog/updatedDateTime" } } }, "SortItem_c9f3a14a": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/changeLog/createdDateTime", "/changeLog/updatedDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/createdDateTime" } } }, "Sort_25cdebca": { "type": "array", "items": { "$ref": "#/components/schemas/SortItem_c9f3a14a" } }, "Sort_26d808b4": { "type": "array", "items": { "$ref": "#/components/schemas/SortItem_5289102a" } }, "Sort_2898cbcc": { "type": "array", "items": { "$ref": "#/components/schemas/SortItem_aedf91e4" } }, "Sort_4cbe2ffe": { "type": "array", "items": { "type": "object", "properties": { "direction": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction.", "default": "DESC" }, "property": { "enum": [ "/changeLog/createdDateTime" ], "type": "string", "description": "Possible field names to use on sorting.", "default": "/changeLog/createdDateTime" } } } }, "Sort_57c2d2b3": { "type": "array", "items": { "$ref": "#/components/schemas/SortItem_3c499a95" } }, "Sort_c782f755": { "type": "array", "items": { "required": [ "direction", "property" ], "type": "object", "properties": { "direction": { "enum": [ "ASC", "DESC" ], "type": "string", "description": "direction of sorting.", "default": "ASC", "example": "ASC" }, "property": { "type": "string", "description": "property used for sorting", "example": "/name" } } } }, "Sort_e73065ca": { "type": "array", "items": { "type": "object", "properties": { "direction": { "enum": [ "DESC", "ASC" ], "type": "string", "description": "Sorting direction.", "default": "DESC" }, "property": { "enum": [ "/code", "/startDateTime", "/endDateTime" ], "type": "string", "description": "Possible field names to use on sorting.", "default": "/startDateTime" } } } }, "Sort_ef18c327": { "type": "array", "items": { "type": "object", "properties": { "direction": { "$ref": "#/components/schemas/CloudRouterSortDirection" }, "property": { "enum": [ "/changeLog/createdDateTime" ], "type": "string", "description": "Possible field names to use on sorting", "default": "/changeLog/createdDateTime" } } } }, "Source": { "required": [ "ipSubnets" ], "type": "object", "properties": { "appLink": { "$ref": "#/components/schemas/AppLink" }, "ipSubnets": { "type": "array", "items": { "type": "string", "format": "ipv4-cidr", "example": "192.168.100.0/24" }, "description": "List of IP subnets in CIDR notation" } }, "description": "Source details for the Subscription", "x-order": 4 }, "SshUsersItem_0c2b6b79": { "required": [ "action" ], "type": "object", "properties": { "sshUserUuid": { "type": "string", "description": "Required for DELETE operation.", "example": "999a3aa2-c49a-dddd-98a6-007424e73777" }, "action": { "enum": [ "CREATE", "DELETE", "REUSE" ], "type": "string", "description": "SSH operation to be performed", "example": "CREATE" }, "sshUsername": { "type": "string", "description": "SSH User name", "example": "cust0001_DC" }, "sshPassword": { "type": "string", "description": "SSH Password", "example": "projPass" } } }, "SshUsersItem_11e67340": { "type": "object", "properties": { "sshUsername": { "type": "string", "description": "sshUsername. This should be minimum 3 and maximum 32 characters and include alphanumeric characters, dash, and underscore.", "example": "cust0001_DC" }, "sshPassword": { "type": "string", "description": "sshPassword", "example": "projPass" }, "sshUserUuid": { "type": "string", "description": "sshUserUuid", "example": "999a3aa2-c49a-dddd-98a6-007424e73777" }, "action": { "enum": [ "CREATE", "UPDATE", "DELETE" ], "type": "string", "description": "Action to perform on the SSH user", "example": "CREATE" } }, "description": "Details of an SSH user" }, "SshUsers_922add19": { "type": "array", "items": { "$ref": "#/components/schemas/SshUsersItem_11e67340" }, "description": "An array of sshUsernames and passwords" }, "SshUsers_d0c792af": { "type": "array", "items": { "$ref": "#/components/schemas/SshUsersItem_0c2b6b79" }, "description": "List of SSH users" }, "State_a5c353e9": { "enum": [ "REQUESTED", "PROVISIONING", "PENDING", "PROVISIONED", "ATTACHED", "FAILED", "PROVISIONING_FAILED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED" ], "type": "string", "description": "ASN lifecycle state", "x-enum-varnames": [ "REQUESTED", "PROVISIONING", "PENDING", "PROVISIONED", "ATTACHED", "FAILED", "PROVISIONING_FAILED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED" ] }, "State_f029ca86": { "type": "array", "items": { "enum": [ "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONED", "DEPROVISIONING", "DEPROVISIONING_FAILED", "DEPROVISIONED", "REPROVISIONING" ], "type": "string", "description": "App Link lifecycle state", "format": "string", "example": "PROVISIONING", "x-order": 6 }, "description": "Filter attached App Links by lifecycle state.", "example": [ "PROVISIONED", "PROVISIONING" ] }, "Status_0819e0b5": { "type": "object", "properties": { "type": { "enum": [ "INFO" ], "type": "string", "description": "[INFO|ERROR] are the possible values" }, "statuscode": { "type": "number", "description": "[1000|3001|3002|3003|4000] are the possible status codes", "example": 1000 }, "msg": { "type": "string", "description": "[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages possible messages", "example": "OK" } } }, "Status_362bd37d": { "type": "object", "properties": { "type": { "enum": [ "INFO" ], "type": "string", "description": "[INFO|ERROR] are the possible values" }, "statuscode": { "type": "number", "description": "[1000|3001|3002|3003|4000] are the possible status codes", "example": 1000 }, "msg": { "type": "string", "description": "[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages", "example": "OK" } } }, "Status_7ce217c1": { "type": "object", "properties": { "type": { "enum": [ "INFO" ], "type": "string", "description": "[INFO|ERROR] are the possible values" }, "statuscode": { "type": "number", "description": "[1000|3001|3002|3003|4000] are the possible status codes", "example": 1000 }, "msg": { "type": "string", "description": "[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the", "example": "OK" } } }, "Status_ae81556b": { "type": "object", "properties": { "type": { "enum": [ "INFO" ], "type": "string", "description": "[INFO|ERROR] are the possible values" }, "statuscode": { "type": "number", "description": "[1000|3001|3002|3003|3004|3005|4000|5000|6001] are the possible status codes", "example": 1000 }, "msg": { "$ref": "#/components/schemas/Msg" } } }, "Sts_createOidcProviderResult": { "properties": { "jwks": { "$ref": "#/components/schemas/Jwks" }, "idpId": { "type": "string", "pattern": "^idp:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a trusted Identity Provider within a root project.", "example": "idp:my-idp" }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "issuerLocation": { "type": "string", "maxLength": 2048, "minLength": 1, "description": "The OIDC issuer location URL.", "example": "https://example.com/oidc" }, "name": { "type": "string", "maxLength": 100, "minLength": 2, "description": "A human-friendly name for the identity provider.", "example": "My OIDC Provider" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "issuerUri": { "type": "string", "pattern": "^https://[a-zA-Z0-9-.]+(:[1-9][0-9]{0,4})?((?:[-a-zA-Z0-9$_.+!*'(),/]|%[0-9a-fA-F]{2})+)?$", "description": "The value of the `iss` claim as returned by this provider. Must be unique within the root project.", "example": "https://example.com/oidc" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "status": { "type": "string", "enum": [ "ENABLED", "SUSPENDED" ], "description": "* \"ENABLED\": the provider is trusted, and token exchange is enabled\n * \"SUSPENDED\": token exchange for ID tokens from this provider is currently disabled", "example": "ENABLED" }, "groupMembershipClaim": { "$ref": "#/components/schemas/GroupMembershipClaim" }, "trustedClientIds": { "$ref": "#/components/schemas/TrustedClientIds" }, "jwksRetrievedAt": { "type": "string", "description": "Timestamp string formatted like: \"2025-02-13T17:10:00.864707507Z\".", "example": "2025-02-13T17:10:00.864707507Z" } }, "additionalProperties": false, "type": "object", "required": [ "name", "trustedClientIds", "idpId", "issuerUri", "issuerLocation", "jwks", "status", "jwksRetrievedAt", "createdBy", "createdAt", "rev" ], "description": "Represents a trust relationship with an OpenID Connect Identity Provider.", "x-fastmcp-top-level-schema": "OIDCProvider" }, "SubtractItem": { "properties": { "resources": { "$ref": "#/components/schemas/Resources_31826c88" }, "serviceActions": { "$ref": "#/components/schemas/ServiceActions_393383e5" }, "condition": { "type": "string", "example": "context.myAttribute < 5" }, "ibxLocationCondition": { "$ref": "#/components/schemas/IbxLocationCondition" } }, "additionalProperties": false, "type": "object", "required": [ "resources", "serviceActions" ], "description": "The PermissionSet defined by crossing the named resources with the named actions." }, "Subtract_46ea2c39": { "items": { "$ref": "#/components/schemas/SubtractItem" }, "type": "array", "uniqueItems": true, "description": "Entries in the `subtract` field are not included in the results from this permission\n object." }, "Subtract_8f4fe610": { "properties": { "managedPolicies": { "items": { "type": "string", "pattern": "^managedpolicy:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed policy globally.", "example": "managedpolicy:my-policy" }, "type": "array", "maxItems": 50, "minItems": 1, "uniqueItems": true }, "managedPermissionSets": { "items": { "type": "string", "pattern": "^managedset:[a-zA-Z](?![^:]*-$)(?![^:]*--)[a-zA-Z0-9-]{0,49}$", "description": "Uniquely identifies a managed permission set globally.", "example": "managedset:my-set" }, "type": "array", "maxItems": 50, "minItems": 1, "uniqueItems": true } }, "additionalProperties": false, "type": "object" }, "Subtract_d5f41db4": { "allOf": [ { "$ref": "#/components/schemas/Subtract_8f4fe610" }, {} ] }, "SystemAlert": { "type": "array", "items": { "$ref": "#/components/schemas/SystemAlertItem" }, "description": "List of system alert message type to subscribe" }, "SystemAlertItem": { "required": [ "accountNumber", "ibx" ], "type": "object", "properties": { "accountNumber": { "type": "string", "example": "135888" }, "ibx": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "description": "System Alert messages are sent when Equinix-defined alert conditions become true. The message contains the data point value that triggered the alert as well as the current value." }, "TagsItem_c5fc2f6e": { "type": "object", "properties": { "href": { "type": "string", "format": "uri", "example": "https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0" }, "uuid": { "type": "string", "format": "uuid", "example": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0" }, "type": { "type": "string", "example": "PREDEFINED_TAG" }, "name": { "type": "string", "example": "equinix.fabric.spotlight.ai.llm" }, "displayName": { "type": "string", "example": "LLM" }, "state": { "enum": [ "APPROVED", "PENDING_APPROVAL", "REJECTED" ], "type": "string", "description": "Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT", "example": "PENDING_APPROVAL" }, "notifications": { "$ref": "#/components/schemas/Notifications_ebd7698b" }, "changeLog": { "$ref": "#/components/schemas/ChangeLog_4b21b6d2" }, "weight": { "type": "integer", "example": 30000 } }, "description": "Equinix Fabric Tag Response Object" }, "TagsItem_f66e94ac": { "type": "object", "properties": { "value": { "type": "string", "description": "Current data value for the tag point", "example": "4.9" }, "tagId": { "type": "string", "description": "ID for the tagPoint - Unique Identifier for the Tag Point", "example": "CH1.Chiller-1:evapleavingwatertemperature" }, "tagDisplayName": { "type": "string", "description": "Generic label for the tag point", "example": "Evaporator Leaving Water Temperature" }, "uom": { "type": "string", "description": "Unit of measure for the data value for the tag point", "example": "°C" }, "alarmStatus": { "type": "string", "description": "Generic label for the tag point", "example": "OK" }, "readingTime": { "type": "string", "description": "date time when the tag point value was read from the device.", "example": "20170907060449" } }, "description": "Tag Point is a property of the Asset it is linked to." }, "Tags_b7839971": { "type": "array", "items": { "$ref": "#/components/schemas/TagsItem_f66e94ac" }, "description": "List of tag points for the Asset" }, "Tags_d567d07b": { "type": "array", "items": { "$ref": "#/components/schemas/TagsItem_c5fc2f6e" }, "example": [ { "href": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387", "uuid": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387", "type": "RESOURCE_TAG", "name": "environment", "displayName": "Environment", "weight": 30000 } ] }, "Target": { "required": [ "prioritization", "geoScope" ], "type": "object", "properties": { "appService": { "$ref": "#/components/schemas/AppService" }, "geoScope": { "type": "string", "description": "Geo scope", "example": "GLOBAL" }, "prioritization": { "enum": [ "LATENCY", "PERFORMANCE", "UTILIZATION", "THRESHOLD", "ANY_TAG" ], "type": "string", "description": "Prioritization strategy for forwarding API requests", "example": "LATENCY" } }, "description": "Target details for the Subscription", "x-order": 5 }, "Temperature": { "allOf": [ { "$ref": "#/components/schemas/Humidity_a99084b4" } ], "description": "Sensor reading - temperature" }, "Tether": { "type": "object", "properties": { "crossConnectId": { "type": "string", "description": "Port cross connect identifier" }, "cabinetNumber": { "type": "string", "description": "Port cabinet number" }, "systemName": { "type": "string", "description": "Port system name" }, "patchPanel": { "type": "string", "description": "Port patch panel" }, "patchPanelPortA": { "type": "string", "description": "Port patch panel port A" }, "patchPanelPortB": { "type": "string", "description": "Port patch panel port B" }, "ibx": { "type": "string", "description": "z-side/Equinix IBX" } }, "description": "Port physical connection" }, "Threshold": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of measurement for the threshold value (e.g., %)", "example": "%" }, "value": { "type": "string", "description": "Threshold value that triggers the alert", "example": "95" }, "min": { "type": [ "object", "null" ], "description": "Minimum threshold value (used for range-based conditions)" }, "max": { "type": [ "object", "null" ], "description": "Maximum threshold value (used for range-based conditions)" } }, "description": "Threshold configuration for a power alert condition" }, "TimeZoneEnum": { "title": "TimeZoneEnum", "enum": [ "Atlantic/Canary", "Europe/Dublin", "Europe/London", "Europe/Lisbon", "Africa/Algiers", "Europe/Berlin", "Europe/Amsterdam", "Europe/Copenhagen", "Europe/Madrid", "Europe/Paris", "Europe/Stockholm", "Europe/Zurich", "Europe/Warsaw", "Africa/Cairo", "Africa/Johannesburg", "Europe/Sofia", "Africa/Nairobi", "Asia/Jerusalem", "Europe/Istanbul", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Kabul", "Asia/Tehran", "Asia/Karachi", "Indian/Maldives", "Asia/Kolkata", "Asia/Kathmandu", "Asia/Omsk", "Asia/Rangoon", "Asia/Jakarta", "Asia/Ho_Chi_Minh", "Asia/Brunei", "Asia/Hong_Kong", "Asia/Kuala_Lumpur", "Asia/Manila", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Australia/Perth", "Asia/Seoul", "Asia/Tokyo", "Australia/Darwin", "Australia/Brisbane", "Pacific/Guam", "Australia/Adelaide", "Australia/Sydney", "Pacific/Auckland", "Pacific/Chatham", "Indian/Christmas", "America/Scoresbysund", "Atlantic/South_Georgia", "America/Sao_Paulo", "America/Detroit", "America/New_York", "America/Puerto_Rico", "America/Toronto", "America/Bogota", "America/Chicago", "America/Winnipeg", "America/Denver", "America/Edmonton", "America/Mexico_City", "America/Los_Angeles", "America/Vancouver", "America/Phoenix", "America/Anchorage", "Pacific/Gambier", "Pacific/Marquesas", "Pacific/Honolulu", "Pacific/Fiji", "Asia/Muscat", "America/Argentina/Buenos_Aires", "America/Caracas", "Etc/GMT+12", "UTC", "GMT", "America/Santiago", "America/St_Johns", "Asia/Almaty", "Asia/Bankgkok", "Asia/Calcutta", "Asia/Magadan", "Asia/Yekaterinburg", "Australia/Eucla", "Australia/Lord_Howe", "Europe/Bratislava", "Europe/Brussels", "Europe/Prague", "Europe/Rome", "Pacific/Kiritimati", "Pacific/Midway", "Pacific/Tongatapu" ], "type": "string", "description": "Time Zone Enum values.", "example": "America/Los_Angeles" }, "Timezone_83d81d7f": { "enum": [ "Atlantic/Canary", "Europe/Dublin", "Europe/London", "Europe/Lisbon", "Africa/Algiers", "Europe/Berlin", "Europe/Amsterdam", "Europe/Copenhagen", "Europe/Madrid", "Europe/Paris", "Europe/Stockholm", "Europe/Zurich", "Europe/Warsaw", "Africa/Cairo", "Africa/Johannesburg", "Africa/Lagos", "Europe/Sofia", "Africa/Nairobi", "Asia/Jerusalem", "Europe/Istanbul", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Kabul", "Asia/Tehran", "Asia/Karachi", "Indian/Maldives", "Asia/Kolkata", "Asia/Kathmandu", "Asia/Omsk", "Asia/Rangoon", "Asia/Jakarta", "Asia/Ho_Chi_Minh", "Asia/Brunei", "Asia/Hong_Kong", "Asia/Kuala_Lumpur", "Asia/Manila", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Australia/Perth", "Asia/Seoul", "Asia/Tokyo", "Australia/Darwin", "Australia/Brisbane", "Pacific/Guam", "Australia/Adelaide", "Australia/Sydney", "Pacific/Auckland", "Pacific/Chatham", "Indian/Christmas", "America/Scoresbysund", "Atlantic/South_Georgia", "America/Sao_Paulo", "America/Detroit", "America/New_York", "America/Puerto_Rico", "America/Toronto", "America/Bogota", "America/Chicago", "America/Winnipeg", "America/Denver", "America/Edmonton", "America/Mexico_City", "America/Los_Angeles", "America/Vancouver", "America/Phoenix", "America/Anchorage", "America/Halifax", "America/Lima", "America/Monterrey", "Pacific/Gambier", "Pacific/Marquesas", "Pacific/Honolulu", "Pacific/Fiji", "Asia/Muscat", "America/Argentina/Buenos_Aires", "America/Caracas", "Etc/GMT+12", "UTC", "GMT", "America/Santiago", "America/St_Johns", "Asia/Almaty", "Asia/Bangkok", "Asia/Calcutta", "Asia/Magadan", "Asia/Yekaterinburg", "Australia/Eucla", "Australia/Lord_Howe", "Europe/Bratislava", "Europe/Brussels", "Europe/Prague", "Europe/Rome", "Europe/Helsinki", "Pacific/Kiritimati", "Pacific/Midway", "Pacific/Tongatapu", "Australia/Melbourne", "Australia/NSW", "Australia/Queensland", "Australia/South", "Australia/Victoria", "Australia/West", "Australia/Canberra" ], "type": "string", "description": "Time Zone Enum values.", "example": "America/Los_Angeles" }, "Timezone_fd353090": { "enum": [ "Atlantic/Canary", "Europe/Dublin", "Europe/London", "Europe/Lisbon", "Africa/Algiers", "Europe/Berlin", "Europe/Amsterdam", "Europe/Copenhagen", "Europe/Madrid", "Europe/Paris", "Europe/Stockholm", "Europe/Zurich", "Europe/Warsaw", "Africa/Cairo", "Africa/Johannesburg", "Africa/Lagos", "Europe/Sofia", "Africa/Nairobi", "Asia/Jerusalem", "Europe/Istanbul", "Europe/Moscow", "Asia/Riyadh", "Asia/Dubai", "Asia/Kabul", "Asia/Tehran", "Asia/Karachi", "Indian/Maldives", "Asia/Kolkata", "Asia/Kathmandu", "Asia/Omsk", "Asia/Rangoon", "Asia/Jakarta", "Asia/Ho_Chi_Minh", "Asia/Brunei", "Asia/Hong_Kong", "Asia/Kuala_Lumpur", "Asia/Manila", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Australia/Perth", "Asia/Seoul", "Asia/Tokyo", "Australia/Darwin", "Australia/Brisbane", "Pacific/Guam", "Australia/Adelaide", "Australia/Sydney", "Pacific/Auckland", "Pacific/Chatham", "Indian/Christmas", "America/Scoresbysund", "Atlantic/South_Georgia", "America/Sao_Paulo", "America/Detroit", "America/New_York", "America/Puerto_Rico", "America/Toronto", "America/Bogota", "America/Chicago", "America/Winnipeg", "America/Denver", "America/Edmonton", "America/Mexico_City", "America/Los_Angeles", "America/Vancouver", "America/Phoenix", "America/Anchorage", "America/Halifax", "America/Lima", "America/Monterrey", "Pacific/Gambier", "Pacific/Marquesas", "Pacific/Honolulu", "Pacific/Fiji", "Asia/Muscat", "America/Argentina/Buenos_Aires", "America/Caracas", "Etc/GMT+12", "UTC", "GMT", "America/Santiago", "America/St_Johns", "Asia/Almaty", "Asia/Bangkok", "Asia/Calcutta", "Asia/Magadan", "Asia/Yekaterinburg", "Australia/Eucla", "Australia/Lord_Howe", "Europe/Bratislava", "Europe/Brussels", "Europe/Prague", "Europe/Rome", "Europe/Helsinki", "Pacific/Kiritimati", "Pacific/Midway", "Pacific/Tongatapu", "Australia/Melbourne", "Australia/NSW", "Australia/Queensland", "Australia/South", "Australia/Victoria", "Australia/West", "Australia/Canberra" ], "type": "string", "description": "List of Equinix supported timezones.", "example": "America/Los_Angeles" }, "TrustedClientIds": { "items": { "type": "string", "maxLength": 100, "minLength": 2, "example": "my-oauth-client-id" }, "type": "array", "maxItems": 10, "minItems": 0, "description": "List of OAuth 2.0 client ids for this provider that are permitted to exchange ID tokens for access tokens. The value of the `aud` claim in an ID token is checked against this list during token exchange." }, "Type_0116f717": { "allOf": [ { "$ref": "#/components/schemas/Type_2066d11d" } ] }, "Type_0aa3b340": { "enum": [ "XC_LINK_LIGHT_VERIFICATION", "XC_PATCH_EQUIPMENT" ], "type": "string", "description": "Type of service ordered alongside the Cross Connect.
XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned.
XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device.\n", "example": "XC_LINK_LIGHT_VERIFICATION" }, "Type_2066d11d": { "enum": [ "XC_SIGNATURE_SUBMISSION", "XC_PROPOSED_DATE_TIME_ACCEPTANCE", "XC_PROPOSED_DATE_TIME_REJECTION", "XC_CANCEL", "XC_DEINSTALL", "XC_INFORMATION_UPDATE" ], "type": "string", "description": "Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment.\n", "example": "XC_SIGNATURE_SUBMISSION" }, "Type_cea3cefc": { "title": "Type", "enum": [ "ORDERS", "SMART_HANDS_SUPPORT_PLAN", "NETWORK_SPECIFICATION", "NETWORK_INCIDENT", "NETWORK_MAINTENANCE", "VIRTUAL_ASSET_UPDATES", "IBX_MAINTENANCE", "IBX_INCIDENT", "IBX_ADVISORY", "IBX_SECURITY_INCIDENT", "MANAGED_SERVICES_INCIDENT", "MANAGED_SERVICES_IBX_MAINTENANCE", "MANAGED_SERVICES_NETWORK_MAINTENANCE" ], "type": "string", "description": "Notification types." }, "Type_d79564c4": { "allOf": [ { "$ref": "#/components/schemas/Type_0aa3b340" } ] }, "Type_de450d9f": { "enum": [ "SINGLE_PORT", "DUAL_PORT" ], "type": "string", "description": "SINGLE_PORT - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide\nDUAL_PORT - Internet Access Service supported with two redundant Connections originating from two redundant AccessPoints on the Aside and terminating to two redundant Internet Routers on the ZSide\n", "example": "SINGLE_PORT" }, "Type_f2c412ba": { "enum": [ "SINGLE", "DUAL" ], "type": "string", "description": "SINGLE - Internet Access Service supported with one Connection originating from one AccessPoint on the ASide\nDUAL - Internet Access Service supported with two redundant Connections originating from two redundant AccessPoints on the Aside and terminating to two redundant Internet Routers on the ZSide\n", "example": "SINGLE" }, "Type_fe0885cb": { "enum": [ "CONNECTION_CREATION_ACCEPTANCE", "CONNECTION_CREATION_REJECTION", "CONNECTION_UPDATE_ACCEPTANCE", "CONNECTION_UPDATE_REJECTION", "CONNECTION_DELETION_ACCEPTANCE", "CONNECTION_REJECTION_ACCEPTANCE", "CONNECTION_UPDATE_REQUEST", "MIGRATION_EVPL_VC", "CONNECTION_PROVIDER_STATUS_REQUEST", "CONNECTION_PROVIDER_BANDWIDTH_REQUEST", "ACCEPT_HOSTED_CONNECTION", "CANCEL_EVPL_VC_DRAFT_ORDERS", "CONNECTION_CREATION_RETRY", "CONNECTION_DELETION_RETRY", "CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST" ], "type": "string", "description": "Connection action type" }, "UnitPricing": { "type": "array", "items": { "$ref": "#/components/schemas/Pricing_Details" } }, "UnitPricingItem": { "type": "object", "properties": { "value": { "type": "number", "description": "To be used with `valueType` and `type`. Can be used to denote price or discount for an order or service" }, "valueType": { "enum": [ "ABSOLUTE", "PERCENTAGE" ], "type": "string", "description": "To indicate if `value` is of absolute or percentage value. i.e Use ABSOLUTE for $50 or PERCENTAGE for 50%" }, "type": { "enum": [ "ONE_TIME_CHARGE", "MONTHLY_CHARGE", "MONTHLY_DISCOUNT", "ONE_TIME_DISCOUNT" ], "type": "string", "description": "To indicate the type of `value` and `valueType`. " } }, "description": "Pricing details for a particular service or order, This can be one time charge or recurring charge" }, "UserAccessPolicyData": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "permissions": { "$ref": "#/components/schemas/Permissions_0c73f7d1" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "ern": { "$ref": "#/components/schemas/AccessPolicyId_542bc819" }, "disabledPolicy": { "enum": [ true ], "example": true }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "managed": { "enum": [ true ], "example": true }, "intersect": { "$ref": "#/components/schemas/Intersect" }, "subtract": { "$ref": "#/components/schemas/Subtract_46ea2c39" }, "accessPolicyId": { "$ref": "#/components/schemas/AccessPolicyId_e60f61ab" }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "tags", "permissions", "rev", "ern", "accessPolicyId" ], "title": "UserAccessPolicyData", "description": "A set of permissions that is granted to principals, groups, or other projects.", "x-fastmcp-top-level-schema": "AccessPolicy" }, "UserPrincipalPolicyData": { "properties": { "description": { "type": "string", "pattern": "^.{0,500}$", "example": "A description string." }, "tags": { "additionalProperties": { "type": "string", "pattern": "^.{0,120}$", "example": "my tag value" }, "type": "object", "maxProperties": 10, "description": "Additional user-controlled data about this resource." }, "updatedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "userPrincipal": { "$ref": "#/components/schemas/Grantee_b325aced" }, "permissions": { "$ref": "#/components/schemas/Permissions_be44d883" }, "createdBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to create the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "createdAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was created. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "rev": { "type": "string", "pattern": "^.*$", "description": "An opaque string that represents the revision of a given resource. Each time the resource is updated, this value\n changes.", "example": "abc123" }, "approvedAt": { "type": "string", "pattern": "^.*$", "description": "A string timestamp indicating when the resource was last updated. Formatted like: \"2025-02-12T17:24:19.033772087Z\"", "example": "2024-01-15T12:00:00Z" }, "disabledPolicy": { "enum": [ true ], "example": true }, "updatedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who last invoked an operation to update the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" }, "approvedBy": { "type": "string", "pattern": "^.*$", "description": "A string indicating the principal who invoked an operation to approve the resource.", "example": "principal:ABCD-EFG-12345:idp:example-user" } }, "additionalProperties": false, "type": "object", "required": [ "userPrincipal", "permissions", "tags", "rev" ], "title": "UserPrincipalPolicyData", "description": "A policy specific to a principal within a governance domain.", "x-fastmcp-top-level-schema": "PrincipalPolicy" }, "UserPublicKey_2ffeec4b": { "type": "object", "properties": { "username": { "type": "string", "description": "Username.", "example": "test-user-1" }, "publicKeyName": { "type": "string", "description": "Key name.", "example": "test-pk-2" }, "publicKey": { "$ref": "#/components/schemas/PublicKey" } }, "description": "An object with public key details." }, "UserPublicKey_6fc2aa31": { "type": "object", "properties": { "username": { "type": "string", "description": "Username.", "example": "test-user-1" }, "keyName": { "type": "string", "description": "Key name. This field may be required for some vendors. The keyName must be an existing keyName associated with an existing keyValue. To set up a new keyName and keyValue pair, call Create Public Key.", "example": "test-pk-2" } }, "description": "An object with public key details." }, "Value_568ccaf0": { "required": [ "type", "name", "project" ], "type": "object", "properties": { "type": { "enum": [ "BGP_IPv4_PREFIX_AGGREGATION", "BGP_IPv6_PREFIX_AGGREGATION" ], "type": "string", "description": "Route Aggregation type" }, "name": { "type": "string", "example": "My-direct-route-1" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } } }, "Value_56ee99c6": { "required": [ "type", "name", "project" ], "type": "object", "properties": { "type": { "enum": [ "BGP_IPv4_PREFIX_FILTER", "BGP_IPv6_PREFIX_FILTER" ], "type": "string", "description": "Route Filter type" }, "name": { "type": "string", "example": "My-direct-route-1" }, "description": { "type": "string", "description": "Customer-provided connection description" }, "project": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "type": "string", "description": "Subscriber-assigned project ID", "example": "44f4c4f8-2f39-494e-838c-d8e640591be5" } } } } }, "Value_ca751d15": { "type": "object", "properties": { "alertTagValue": { "type": "string", "description": "tag reading raw value", "example": "1" }, "alertTagValueDisplayName": { "type": "string", "description": "tag reading display value", "example": "NORMAL" }, "activeAlertTagValueDisplayName": { "type": "string", "description": "active tag reading display value", "example": "ALARM" }, "currentTagValue": { "type": "string", "description": "current tag reading display value", "example": "NORMAL" } } }, "Values": { "type": "array", "items": { "type": "string" }, "description": "### Supported event or metric names to use on filters with property /type:\n * `*` - all events or metrics\n * `equinix.fabric.company_profile.*` - company profile events\n * `equinix.fabric.connection.*` - connection events, metrics, or alerts\n * `equinix.fabric.connection_bgpipv4_session.*` - connection BGP IPv4 session events\n * `equinix.fabric.connection_bgpipv6_session.*` - connection BGP IPv6 session events\n * `equinix.fabric.connection_maintenance.*` - connection maintenance events\n * `equinix.fabric.connection_route_aggregation.*` - connection route aggregation events\n * `equinix.fabric.connection_route_filter.*` - connection route filter events\n * `equinix.fabric.connection_routing_protocol.*` - connection routing protocol events\n * `equinix.fabric.internet_access.*` - internet access service events\n * `equinix.fabric.ip_block.*` - IP block events\n * `equinix.fabric.metric` - metric collection events\n * `equinix.fabric.metro.*` - metro metrics or alerts\n * `equinix.fabric.network.*` - network events\n * `equinix.fabric.physical_port.*` - physical port events\n * `equinix.fabric.port.*` - virtual port events, metrics, or alerts\n * `equinix.fabric.port_maintenance.*` - port maintenance events\n * `equinix.fabric.route_aggregation.*` - route aggregation events\n * `equinix.fabric.route_aggregation_rule.*` - route aggregation rule events\n * `equinix.fabric.route_filter.*` - route filter events\n * `equinix.fabric.route_filter_rule.*` - route filter rule events\n * `equinix.fabric.router.*` - cloud router events or alerts\n * `equinix.fabric.router_action.*` - cloud router action events\n * `equinix.fabric.router_command.*` - cloud router command events\n * `equinix.fabric.routing_protocol_action.*` - routing protocol action events\n * `equinix.fabric.service_profile_connection.*` - service profile connection events\n * `equinix.fabric.service_token.*` - service token events\n * `equinix.fabric.time_service.*` - precision time service events\n * `equinix.network.maintenance.*` - network maintenance events\n * `equinix.network.repair.*` - network repair events\n * `equinix.network_edge.*` - network edge events, metrics, or alerts\n * `equinix.network_edge.acl.*` - network edge acl events\n * `equinix.network_edge.device.*` - network edge device events\n * `equinix.network_edge.device_interface.*` - network edge device interface metrics or alerts\n * `equinix.network_edge.devicelinkgroup.*` - network edge device link group events\n * `equinix.access_manager.*` - identity access manager events\n * `equinix.access_manager.user.role.*` - identity access manager user role events\n * `equinix.iam.principal.*` - IAM principal authorization and token events\n * `equinix.identity.user.*` - identity user events\n * `equinix.identity.organization.*` - identity organization membership events\n * `equinix.resource_manager.organization.*` - resource manager organization events\n * `equinix.resource_manager.project.*` - resource manager project events\n### Supported event or metric names to use on filters with property /subject:\n * `*` - all events or metrics\n * `/fabric/v4/ports/` - port events or metrics\n * `/fabric/v4/ports//maintenances/` - port maintenance events\n * `/fabric/v4/connections/` - connection events or metrics\n * `/fabric/v4/connections//maintenances/` - connection maintenance events\n * `/fabric/v4/routers/` - cloud router events\n * `/fabric/v4/metros/` - metro metrics\n * `/fabric/v4/networks/` - network events\n * `/fabric/v4/tokens/` - service token events\n * `/ne/v1/acl/` - network edge acl events\n * `/ne/v1/devices/` - network edge device events\n * `/am/v2/users//roleAssignments/` - identity access manager events\n" }, "VendorConfig_039cfa6b": { "type": "object", "properties": { "hostname": { "type": "string", "description": "The host name. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14; Aruba 2-24.", "example": "myname1" }, "rootPassword": { "type": "string", "description": "Root password for the device.", "example": "myPassw0rd!" }, "adminPassword": { "type": "string", "description": "The administrative password of the device. You can use it to log in to the console. This field is not available for all device types.", "example": "ZQeIDI7sUd" }, "panoramaIpAddress": { "type": "string", "description": "IP address of the Panorama controller. Provide this value to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access", "example": "1.1.1.1" }, "panoramaAuthKey": { "type": "string", "description": "This key supports secure onboarding of the Palo Alto firewall devices. Provide this value to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access.", "example": "123456" } }, "description": "Vendor configuration for node 1" }, "VendorConfig_1126b9ef": { "type": "object", "properties": { "hostname": { "type": "string", "description": "The host name. Only a-z, A-Z, 0-9, and hyphen(-) are allowed. It should start with a letter and end with a letter or digit. The length should be between 2-30 characters. Exceptions - FTDv 2-14; Aruba 2-24.", "example": "myname1" }, "activationKey": { "type": "string", "description": "Activation key for the device.", "example": "GJUK-JM2X-59BJ-2TDJ" }, "controllerFqdn": { "type": "string", "description": "Controller FQDN.", "example": "demo.velocloud.net" }, "rootPassword": { "type": "string", "description": "Root password for the device.", "example": "myPassw0rd!" }, "adminPassword": { "type": "string", "description": "The administrative password of the device. You can use it to log in to the console. This field is not available for all device types.", "example": "ZQeIDI7sUd" }, "controller1": { "type": "string", "description": "Controller 1 IP address.", "example": "54.219.248.29" }, "panoramaIpAddress": { "type": "string", "description": "IP address of the Panorama controller. Provide this value to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access", "example": "1.1.1.1" }, "panoramaAuthKey": { "type": "string", "description": "This key supports secure onboarding of the Palo Alto firewall devices. Provide this value to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access.", "example": "123456" } }, "description": "Vendor configuration for node 0" }, "VendorConfig_9949fa91": { "type": "object", "properties": { "siteId": { "type": "string", "description": "Physical location within the Viptela overlay network, such as a branch office, or a campus (relevant only for Cisco SD-WANs)", "example": "567" }, "systemIpAddress": { "type": "string", "description": "IP assigned to the router and vSmart controller (relevant only for Cisco SD-WANs)", "example": "192.164.0.0" }, "licenseKey": { "type": "string", "description": "License key", "example": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7" }, "licenseSecret": { "type": "string", "description": "License secret", "example": "h5j0i45e83324pblbfca764532c4a640e7801f0" }, "localId": { "type": "string", "description": "Local ID", "example": "branch1@example.com" }, "remoteId": { "type": "string", "description": "Remote ID", "example": "companyController1@example.com" }, "managementType": { "enum": [ "FMC", "CLI" ], "type": "string", "description": "Device management type.", "example": "FMC" }, "controller1": { "type": "string", "description": "For Fortinet devices, this is the System IP address.", "example": "54.219.248.29" }, "controller2": { "type": "string", "description": "Controller 2 IP address", "example": "54.177.220.115" }, "serialNumber": { "type": "string", "description": "Serial number", "example": "4545454" }, "adminPassword": { "$ref": "#/components/schemas/AdminPassword" }, "activationKey": { "type": "string", "description": "Activation key", "example": "GJUK-JM2X-59BJ-2TDJ" }, "controllerFqdn": { "type": "string", "description": "Controller FQDN", "example": "demo.velocloud.net" }, "rootPassword": { "type": "string", "description": "Root password", "example": "myPassw0rd!" }, "accountName": { "type": "string", "description": "The name of account.", "example": "accountName" }, "hostname": { "type": "string", "description": "The host name.", "example": "myHostname" }, "accountKey": { "type": "string", "description": "The account key.", "example": "Primary Account Key1" }, "applianceTag": { "type": "string", "description": "The appliance tag.", "example": "applianceTag" }, "userName": { "type": "string", "description": "This field is rel", "example": "user123" }, "connectToCloudVision": { "type": "boolean", "description": "Whether you want your Arista device to connect to Cloud Vision. Only relevant for Arista devices.", "example": true }, "cvpType": { "enum": [ "As-a-Service", "On-Premise" ], "type": "string", "description": "Either As-a-Service or On-Premise. Only relevant for Arista devices.", "example": "As-a-Service" }, "cvpFqdn": { "type": "string", "description": "Fully qualified domain name for Cloud Vision As-a-Service.", "example": "www.NetworkSolutions.com" }, "cvpIpAddress": { "type": "string", "description": "Cloud Vision IP address.", "example": "192.168.0.10" }, "cvaasPort": { "type": "string", "description": "Cloud Vision As-a-Service port.", "example": "443" }, "cvpPort": { "type": "string", "description": "Cloud Vision port.", "example": "443" }, "cvpToken": { "type": "string", "description": "Cloud Vision token.", "example": "123" }, "provisioningKey": { "type": "string", "description": "Only relevant for Zscaler devices", "example": "samppleKey" }, "privateAddress": { "type": "string", "description": "Private address. Only relevant for BlueCat devices.", "example": "192.168.20.32" }, "privateCidrMask": { "type": "string", "description": "Private CIDR mask. Only relevant for BlueCat devices.", "example": "24" }, "privateGateway": { "type": "string", "description": "Private gateway. Only relevant for BlueCat devices.", "example": "192.168.20.1" }, "licenseId": { "type": "string", "description": "License Id. Only relevant for BlueCat devices.", "example": "21913599" }, "panoramaIpAddress": { "type": "string", "description": "Provide this field to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access", "example": "1.1.1.1" }, "panoramaAuthKey": { "type": "string", "description": "Provide this field to have Panorama integration. Relevant for Palo Alto Self-Configured devices with Internet Access", "example": "123456" } }, "description": "Vendor-specific configuration" }, "VersionDetails": { "type": "object", "properties": { "cause": { "$ref": "#/components/schemas/VersionDetails" }, "version": { "type": "string", "description": "Version.", "example": "16.09.02" }, "imageName": { "type": "string", "description": "Image name.", "example": "csr-16.09.02" }, "versionDateTime": { "type": "string", "description": "The date the software was released.", "format": "date-time", "example": "2019-01-01T00:00:00Z" }, "retireDateTime": { "type": "string", "description": "The date the software will no longer be available.", "format": "date-time", "example": "2024-12-12T00:00:00Z" }, "status": { "enum": [ "ACTIVE", "INACTIVE", "RETIRED" ], "type": "string", "description": "Version status.", "example": "ACTIVE" }, "stableVersion": { "type": "boolean", "description": "Whether this is a stable version.", "example": true }, "allowedUpgradableVersions": { "type": "array", "items": { "type": "string", "example": "16.09.03" }, "description": "List of allowed upgradable versions." }, "supportedLicenseTypes": { "type": "array", "items": { "enum": [ "BYOL", "Subscription" ], "type": "string" }, "description": "Supported license types.", "example": [ "BYOL", "Subscription" ] } }, "description": "Software version details" }, "VirtualDeviceType": { "type": "object", "properties": { "deviceTypeCode": { "$ref": "#/components/schemas/DeviceTypeCode" }, "name": { "type": "string", "description": "The name of the device.", "example": "C8000V router" }, "description": { "type": "string", "description": "The description of the device.", "example": "Extend your enterprise network to public and private clouds with the C8000V series." }, "vendor": { "type": "string", "description": "The vendor of the device.", "example": "Cisco" }, "category": { "enum": [ "ROUTER", "FIREWALL", "SDWAN" ], "type": "string", "description": "The type of the virtual device, whether router or firewall.", "example": "ROUTER" }, "maxInterfaceCount": { "type": "integer", "description": "The maximum available number of interfaces.", "example": 20 }, "defaultInterfaceCount": { "type": "integer", "description": "The default number of interfaces.", "example": 10 }, "clusterMaxInterfaceCount": { "type": "integer", "description": "The maximum number of available interfaces in case you are clustering.", "example": 100 }, "clusterDefaultInterfaceCount": { "type": "integer", "description": "The default number of available interfaces in case you are clustering.", "example": 50 }, "availableMetros": { "type": "array", "items": { "$ref": "#/components/schemas/Metro" }, "description": "An array of metros where the device is available." }, "softwarePackages": { "type": "array", "items": { "$ref": "#/components/schemas/SoftwarePackage" }, "description": "An array of available software packages" }, "deviceManagementTypes": { "type": "array", "items": { "enum": [ "SELF-CONFIGURED", "EQUINIX-CONFIGURED" ], "type": "string" }, "description": "Device management types configuration" } } }, "VirtualDevice_90030e51": { "type": "object", "properties": { "href": { "type": "string", "description": "Virtual Device URI", "format": "uri" }, "uuid": { "type": "string", "description": "Equinix-assigned Virtual Device identifier", "format": "uuid" }, "name": { "type": "string", "description": "Customer-assigned Virtual Device name" }, "type": { "enum": [ "EDGE" ], "type": "string", "description": "Virtual Device type" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "cluster": { "type": "string", "description": "Virtual Device Cluster Information" } }, "description": "Virtual Device AccessPoint Information" }, "VirtualDevice_d244906a": { "type": "object", "properties": { "href": { "type": "string", "description": "url to entity", "format": "uri" }, "uuid": { "type": "string", "description": "Network Edge assigned Virtual Device Identifier", "format": "uuid" }, "name": { "type": "string", "description": "Customer-assigned Virtual Device name" }, "type": { "enum": [ "EDGE" ], "type": "string", "description": "Type of Virtual Device" }, "account": { "$ref": "#/components/schemas/Account_0dedb04b" }, "cluster": { "type": "string", "description": "Virtual Device Cluster Information" } } }, "VirtualDevice_d2a8a3ae": { "required": [ "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Virtual device identifier", "format": "uuid", "example": "f088e99c-7f69-4380-94bf-d25940064552" }, "type": { "enum": [ "EDGE" ], "type": "string", "description": "Type of virtual device", "example": "EDGE" }, "href": { "type": "string", "description": "Virtual device URI", "example": "https://api.equinix.com/ne/v1/devices/f088e99c-7f69-4380-94bf-d25940064552" } } }, "VirtualDevices": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualDevicesItem" } }, "VirtualDevicesItem": { "required": [ "type", "uuid" ], "type": "object", "properties": { "type": { "enum": [ "VD" ], "type": "string" }, "uuid": { "type": "string", "format": "uuid", "example": "94662143-e21b-4098-bfcf-e9416f47eae1" }, "location": { "$ref": "#/components/schemas/Location_53f78db6" }, "interfaceUuid": { "type": "string", "format": "uuid", "example": "94662143-e21b-4098-bfcf-e9416f47eae1" } }, "description": "Virtual Device Point" }, "WebhookChannelConfiguration": { "required": [ "url" ], "type": "object", "properties": { "sslCertificate": { "type": "string", "example": "ZkFzZLY1IGRpY31kZXI=" }, "url": { "type": "string", "example": "https://b4c3mzxe8syvhd-ats.iot.us-west-2.amazonaws.com" }, "numberOfRetries": { "maximum": 5.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "numberOfConcurrentCalls": { "maximum": 50.0, "minimum": 20.0, "type": "integer", "format": "int32" }, "batchSize": { "maximum": 20.0, "minimum": 5.0, "type": "integer", "format": "int32" } }, "description": "The configuration for a 'WEBHOOK' channel" }, "ZSide_205c456e": { "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_04efc84a" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "Equinix IBX data centre code.", "example": "SV1" } }, "description": "Destination location for BMMR and REMOTE connections." }, "loa": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Identifier of the Letter of Authorization", "example": "64de7e5-7fe7-41e6-b984-80d5aa159a0e" } }, "description": "Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE.\n" } }, "description": "Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization.\n" }, "ZSide_94f5b33c": { "allOf": [ { "$ref": "#/components/schemas/CrossConnectZSideRequest" } ], "description": "Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested.\n" }, "ZSide_def831f6": { "type": "object", "properties": { "demarcationPoint": { "$ref": "#/components/schemas/DemarcationPoint_d8b2b563" }, "location": { "type": "object", "properties": { "ibxCode": { "type": "string", "description": "Equinix IBX data centre code.", "example": "SV1" } }, "description": "Destination location for BMMR and REMOTE connections." }, "loa": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Identifier of the Letter of Authorization", "example": "64de7e5-7fe7-41e6-b984-80d5aa159a0e" } }, "description": "Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE.\n" } }, "description": "Terminating end as provisioned, with the demarcation point and IBX location." }, "_links": { "title": "_links", "type": "object", "properties": { "next": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "example": "/v1/notifications/ibx?limit=10&offset=0" } } }, "self": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "example": "/v1/notifications/ibx?limit=10&offset=0" } } }, "previous": { "title": "ReferenceLink", "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string", "example": "/v1/notifications/ibx?limit=10&offset=0" } } } } }, "CallToolResult": { "type": "object", "description": "MCP CallToolResult returned by tools/call.", "properties": { "content": { "type": "array", "description": "Unstructured result content blocks (text, images, ...).", "items": { "type": "object" } }, "structuredContent": { "type": "object", "description": "Structured result, when the tool provides one." }, "isError": { "type": "boolean" } }, "required": [ "content" ] } } } }