| Method Signature |
Description |
Path |
Workflow? |
| getVirtualDevicesUsingGET(deviceTypeCode, category, offset, limit, callback) |
Get Device Types |
{base_path}/{version}/ne/v1/deviceTypes?{query} |
Yes |
| getMetrosUsingGET(region, offset, limit, callback) |
Get Available Metros |
{base_path}/{version}/ne/v1/metros?{query} |
Yes |
| getAccountsWithStatusUsingGET(metro, accountUcmId, callback) |
Get Accounts {metro} |
{base_path}/{version}/ne/v1/accounts/{pathv1}?{query} |
Yes |
| getAgreementStatusUsingGET(accountNumber, callback) |
Get Agreement Status. |
{base_path}/{version}/ne/v1/agreements/accounts?{query} |
Yes |
| sendAgreementUsingPOST1(agreementAcceptRequest, callback) |
Create an agreement |
{base_path}/{version}/ne/v1/agreements/accounts?{query} |
Yes |
| getVendorTermsUsingGET(vendorPackage, licenseType, callback) |
Get Vendor Terms |
{base_path}/{version}/ne/v1/agreements/vendors?{query} |
Yes |
| getOrderTermsUsingGET(callback) |
Get Order Terms |
{base_path}/{version}/ne/v1/agreements/orders?{query} |
Yes |
| retrievePriceUsingGET(accountNumber, metro, vendorPackage, licenseType, softwarePackage, throughput, throughputUnit, termLength, additionalBandwidth, virtualDeviceUuid, deviceManagementType, core, secondaryAccountNumber, secondaryMetro, secondaryAdditionalBandwidth, accountUcmId, orderingContact, callback) |
Get the Price |
{base_path}/{version}/ne/v1/prices?{query} |
Yes |
| getOrderSummaryUsingGET(accountNumber, metro, vendorPackage, licenseType, softwarePackage, throughput, throughputUnit, termLength, additionalBandwidth, virtualDeviceUuid, deviceManagementType, core, secondaryAccountNumber, secondaryMetro, secondaryAdditionalBandwidth, accountUcmId, orderingContact, callback) |
Get Order Summary |
{base_path}/{version}/ne/v1/orderSummaries?{query} |
Yes |
| sendDnsLookupPOST1(dnsLookupRequest, callback) |
Post DNS Lookup |
{base_path}/{version}/ne/v1/dnsLookup?{query} |
Yes |
| getPublicKeysUsingGET(accountUcmId, callback) |
Get Public Keys |
{base_path}/{version}/ne/v1/publicKeys?{query} |
Yes |
| postPublicKeyUsingPOST(publicKeyRequest, callback) |
Create Public Key |
{base_path}/{version}/ne/v1/publicKeys?{query} |
Yes |
| uploadLicenseUsingPOST(file, metroCode, deviceTypeCode, licenseType, callback) |
Post License File |
{base_path}/{version}/ne/v1/devices/licenseFiles?{query} |
Yes |
| uploadLicenseForDeviceUsingPOST(uuid, file, callback) |
Post License {uuid} |
{base_path}/{version}/ne/v1/devices/licenseFiles/{pathv1}?{query} |
Yes |
| updateLicenseUsingPOST(uuid, request, callback) |
Update License Token/ID/Code |
{base_path}/{version}/ne/v1/devices/{pathv1}/licenseTokens?{query} |
Yes |
| createVirtualDeviceUsingPOST(virtualDevice, draft, draftUuid, callback) |
Create Virtual Device |
{base_path}/{version}/ne/v1/devices?{query} |
Yes |
| getVirtualDevicesUsingGET1(offset, limit, metroCode, status, showOnlySubCustomerDevices, accountUcmId, callback) |
Get Virtual Devices |
{base_path}/{version}/ne/v1/devices?{query} |
Yes |
| getVirtualDeviceUsingGET(uuid, callback) |
Get Virtual Device {uuid} |
{base_path}/{version}/ne/v1/devices/{pathv1}?{query} |
Yes |
| updateVirtualDeviceUsingPATCH1(uuid, virtualDeviceUpdateRequestDto, callback) |
Update Virtual Device |
{base_path}/{version}/ne/v1/devices/{pathv1}?{query} |
Yes |
| deleteVRouterUsingDELETE(uuid, deletionInfo, deleteRedundantDevice, callback) |
Delete Virtual Devices |
{base_path}/{version}/ne/v1/devices/{pathv1}?{query} |
Yes |
| updateVirtualDeviceUsingPUT(draft, virtualDevice, uuid, callback) |
Update Device Draft |
{base_path}/{version}/ne/v1/devices/{pathv1}?{query} |
Yes |
| updateAdditionalBandwidth(uuid, request, callback) |
Update Additional Bandwidth |
{base_path}/{version}/ne/v1/devices/{pathv1}/additionalBandwidths?{query} |
Yes |
| getVirtualDeviceInterfacesUsingGET(uuid, callback) |
Get Device Interfaces |
{base_path}/{version}/ne/v1/devices/{pathv1}/interfaces?{query} |
Yes |
| pingDeviceUsingGET(uuid, callback) |
Ping Virtual Device |
{base_path}/{version}/ne/v1/devices/{pathv1}/ping?{query} |
Yes |
| createDeviceACLTemplateUsingPost(aclTemplateRequest, accountUcmId, callback) |
Create ACL Template |
{base_path}/{version}/ne/v1/aclTemplates?{query} |
Yes |
| getDeviceACLTemplateUsingGET1(offset, limit, accountUcmId, callback) |
Get ACL Templates |
{base_path}/{version}/ne/v1/aclTemplates?{query} |
Yes |
| getDeviceTemplatebyUuid(uuid, accountUcmId, callback) |
Get ACL Template {uuid} |
{base_path}/{version}/ne/v1/aclTemplates/{pathv1}?{query} |
Yes |
| deletedeviceACLUsingDELETE(uuid, accountUcmId, callback) |
Delete ACL template |
{base_path}/{version}/ne/v1/aclTemplates/{pathv1}?{query} |
Yes |
| updateDeviceACLTemplateUsingPUT(uuid, accountUcmId, aclTemplateRequest, callback) |
Update ACL Template |
{base_path}/{version}/ne/v1/aclTemplates/{pathv1}?{query} |
Yes |
| createLinkGroupUsingPOST(deviceLinkGroup, callback) |
Create Device Link |
{base_path}/{version}/ne/v1/links?{query} |
Yes |
| getLinkGroupsUsingGET1(metro, virtualDeviceUuid, accountUcmId, pageNumber, size, callback) |
Get Device Links. |
{base_path}/{version}/ne/v1/links?{query} |
Yes |
| getLinkGroupByUUIDUsingGET(uuid, callback) |
Get Device Link {uuid} |
{base_path}/{version}/ne/v1/links/{pathv1}?{query} |
Yes |
| updateLinkGroupUsingPATCH(uuid, deviceLinkGroup, callback) |
Update Device Link |
{base_path}/{version}/ne/v1/links/{pathv1}?{query} |
Yes |
| deleteLinkGroupUsingDELETE(uuid, callback) |
Delete Device Link |
{base_path}/{version}/ne/v1/links/{pathv1}?{query} |
Yes |
| getProfilesByMetroUsingGET(metroCode, pageNumber, pageSize, callback) |
Get L2 Service Profiles |
{base_path}/{version}/ne/v1/l2/serviceprofiles/services?{query} |
Yes |
| getProfileByIdUsingGET(uuid, callback) |
Get L2 Service Profile {uuid} |
{base_path}/{version}/ne/v1/l2/serviceprofiles/services/{pathv1}?{query} |
Yes |
| validateAuthorizationKeyUsingGET(authorizationKey, metroCode, profileId, region, callback) |
Get L2 Validate Authorization Key |
{base_path}/{version}/ne/v1/l2/connections/validateAuthorizationKey?{query} |
Yes |
| createConnectionUsingPOST(request, callback) |
Create L2 Connection |
{base_path}/{version}/ne/v1/l2/connections?{query} |
Yes |
| performUserActionUsingPATCH(action, uuid, request, callback) |
Update Connection {uuid} |
{base_path}/{version}/ne/v1/l2/connections/{pathv1}?{query} |
Yes |
| getConnectionByUuidUsingGET(uuid, callback) |
Get L2 Connection |
{base_path}/{version}/ne/v1/l2/connections/{pathv1}?{query} |
Yes |
| deleteConnectionUsingDELETE(uuid, callback) |
Delete Connection {uuid} |
{base_path}/{version}/ne/v1/l2/connections/{pathv1}?{query} |
Yes |
| addBgpConfigurationUsingPOST(request, callback) |
Create BGP Peering |
{base_path}/{version}/ne/v1/bgp?{query} |
Yes |
| getBgpConfigurationsUsingGET(virtualDeviceUuid, connectionUuid, status, accountUcmId, offset, limit, callback) |
Get BGP Peering |
{base_path}/{version}/ne/v1/bgp?{query} |
Yes |
| updateBgpConfigurationUsingPUT(uuid, request, callback) |
Update BGP Peering |
{base_path}/{version}/ne/v1/bgp/{pathv1}?{query} |
Yes |
| getBgpConfigurationUsingGET(uuid, callback) |
Get BGP Peering {uuid} |
{base_path}/{version}/ne/v1/bgp/{pathv1}?{query} |
Yes |
| createVpnUsingPOST(request, callback) |
Create VPN Configuration |
{base_path}/{version}/ne/v1/vpn?{query} |
Yes |
| getVpnsUsingGET(statusList = 'PROVISIONED', virtualDeviceUuid, offset, limit, callback) |
Get VPN Configurations |
{base_path}/{version}/ne/v1/vpn?{query} |
Yes |
| getVpnByUuidUsingGET(uuid, callback) |
Get VPN Configuration {uuid} |
{base_path}/{version}/ne/v1/vpn/{pathv1}?{query} |
Yes |
| updateVpnConfigurationUsingPut(uuid, request, callback) |
Update VPN Configuration |
{base_path}/{version}/ne/v1/vpn/{pathv1}?{query} |
Yes |
| removeVpnConfigurationUsingDELETE(uuid, callback) |
Delete VPN Configuration |
{base_path}/{version}/ne/v1/vpn/{pathv1}?{query} |
Yes |
| getSshUsersUsingGET(username, virtualDeviceUuid, verbose, accountUcmId, offset, limit, callback) |
Get SSH Users |
{base_path}/{version}/ne/v1/sshUsers?{query} |
Yes |
| createSshUserUsingPOST(request, callback) |
Create SSH User |
{base_path}/{version}/ne/v1/sshUsers?{query} |
Yes |
| isSshUserAvailableForCreationUsingGET(username, callback) |
SSH User Availability |
{base_path}/{version}/ne/v1/sshUsers/availability?{query} |
Yes |
| getSshUserUsingGET(uuid, callback) |
Get SSH User {uuid} |
{base_path}/{version}/ne/v1/sshUsers/{pathv1}?{query} |
Yes |
| updateSshUserUsingPUT(uuid, request, callback) |
Update SSH User Password |
{base_path}/{version}/ne/v1/sshUsers/{pathv1}?{query} |
Yes |
| dissociateDeviceUsingDELETE(sshUserUuid, deviceUuid, callback) |
Delete SSH User |
{base_path}/{version}/ne/v1/sshUsers/{pathv1}/devices/{pathv2}?{query} |
Yes |
| associateDeviceUsingPOST(sshUserUuid, deviceUuid, callback) |
Update SSH User {uuid} |
{base_path}/{version}/ne/v1/sshUsers/{pathv1}/devices/{pathv2}?{query} |
Yes |
| getServerVersion(callback) |
Get SmartKey version information |
{base_path}/{version}/sys/v1/version?{query} |
Yes |
| checkHealth(callback) |
Check whether the server is handling requests |
{base_path}/{version}/sys/v1/health?{query} |
Yes |
| authorize(callback) |
Create a session for a user or an app |
{base_path}/{version}/sys/v1/session/auth?{query} |
Yes |
| reAuth(callback) |
Create a new session for a user or an app using an existing session bearer token. |
{base_path}/{version}/sys/v1/session/reauth?{query} |
Yes |
| refresh(callback) |
Refreshes existing user or app session. |
{base_path}/{version}/sys/v1/session/refresh?{query} |
Yes |
| terminate(callback) |
Terminate a session |
{base_path}/{version}/sys/v1/session/terminate?{query} |
Yes |
| selectAccount(body, callback) |
Select a user's account to work on |
{base_path}/{version}/sys/v1/session/select_account?{query} |
Yes |
| unlock2F(callback) |
Unlock two factor configuration |
{base_path}/{version}/sys/v1/session/config_2fa/auth?{query} |
Yes |
| getSecurityObjects(name, groupId, creator, sort, compliantWithPolicies, start, limit, offset, callback) |
Get all security objects |
{base_path}/{version}/crypto/v1/keys?{query} |
Yes |
| generateSecurityObject(body, callback) |
Generate a new security object |
{base_path}/{version}/crypto/v1/keys?{query} |
Yes |
| importSecurityObject(body, callback) |
Import a security object |
{base_path}/{version}/crypto/v1/keys?{query} |
Yes |
| getSecurityObject(keyId, callback) |
Get a specific security object |
{base_path}/{version}/crypto/v1/keys/{pathv1}?{query} |
Yes |
| deleteSecurityObject(keyId, callback) |
Delete a security object |
{base_path}/{version}/crypto/v1/keys/{pathv1}?{query} |
Yes |
| updateSecurityObject(keyId, body, callback) |
Update a security object |
{base_path}/{version}/crypto/v1/keys/{pathv1}?{query} |
Yes |
| persistSecurityObject(body, callback) |
Persist a transient key. |
{base_path}/{version}/crypto/v1/keys/persist?{query} |
Yes |
| deletePrivateKey(keyId, callback) |
Remove / Destroy private half of the asymmetric key |
{base_path}/{version}/crypto/v1/keys/{pathv1}/private?{query} |
Yes |
| rotateSecurityObject(body, callback) |
Rotate a key. |
{base_path}/{version}/crypto/v1/keys/rekey?{query} |
Yes |
| getSecurityObjectValueEx(body, callback) |
Retrieve the value of an exportable security object |
{base_path}/{version}/crypto/v1/keys/export?{query} |
Yes |
| getSecurityObjectDigest(body, callback) |
Retrieve the digest (hash) of the value of an exportable security object |
{base_path}/{version}/crypto/v1/keys/digest?{query} |
Yes |
| getSecurityObjectValue(keyId, callback) |
Retrieve the value of an exportable security object |
{base_path}/{version}/crypto/v1/keys/{pathv1}/export?{query} |
Yes |
| activateSecurityObject(keyId, callback) |
Transitions immediately a security object to Active state |
{base_path}/{version}/crypto/v1/keys/{pathv1}/activate?{query} |
Yes |
| revokeSecurityObject(keyId, body, callback) |
Transitions immediately a security object to Deactivated or Compromised state |
{base_path}/{version}/crypto/v1/keys/{pathv1}/revoke?{query} |
Yes |
| deriveKey(keyId, body, callback) |
Derive a key from another key |
{base_path}/{version}/crypto/v1/keys/{pathv1}/derive?{query} |
Yes |
| deriveKeyEx(body, callback) |
Derive a key from another key |
{base_path}/{version}/crypto/v1/derive?{query} |
Yes |
| agreeKey(body, callback) |
Agree on a key from two other keys |
{base_path}/{version}/crypto/v1/agree?{query} |
Yes |
| encrypt(keyId, body, callback) |
Encrypt data |
{base_path}/{version}/crypto/v1/keys/{pathv1}/encrypt?{query} |
Yes |
| encryptEx(body, callback) |
Encrypt data |
{base_path}/{version}/crypto/v1/encrypt?{query} |
Yes |
| batchEncrypt(body, callback) |
Batch encrypt with one or more keys |
{base_path}/{version}/crypto/v1/keys/batch/encrypt?{query} |
Yes |
| encryptInit(keyId, body, callback) |
Begin multi-part encryption |
{base_path}/{version}/crypto/v1/keys/{pathv1}/encrypt/init?{query} |
Yes |
| encryptInitEx(body, callback) |
Begin multi-part encryption |
{base_path}/{version}/crypto/v1/encrypt/init?{query} |
Yes |
| encryptUpdate(keyId, body, callback) |
Continue multi-part encryption |
{base_path}/{version}/crypto/v1/keys/{pathv1}/encrypt/update?{query} |
Yes |
| encryptUpdateEx(body, callback) |
Continue multi-part encryption |
{base_path}/{version}/crypto/v1/encrypt/update?{query} |
Yes |
| encryptFinal(keyId, body, callback) |
Conclude multi-part encryption |
{base_path}/{version}/crypto/v1/keys/{pathv1}/encrypt/final?{query} |
Yes |
| encryptFinalEx(body, callback) |
Conclude multi-part encryption |
{base_path}/{version}/crypto/v1/encrypt/final?{query} |
Yes |
| decrypt(keyId, body, callback) |
Decrypt data |
{base_path}/{version}/crypto/v1/keys/{pathv1}/decrypt?{query} |
Yes |
| decryptEx(body, callback) |
Decrypt data |
{base_path}/{version}/crypto/v1/decrypt?{query} |
Yes |
| batchDecrypt(body, callback) |
Batch decrypt with one or more keys |
{base_path}/{version}/crypto/v1/keys/batch/decrypt?{query} |
Yes |
| decryptInit(keyId, body, callback) |
Begin multi-part decryption |
{base_path}/{version}/crypto/v1/keys/{pathv1}/decrypt/init?{query} |
Yes |
| decryptInitEx(body, callback) |
Begin multi-part decryption |
{base_path}/{version}/crypto/v1/decrypt/init?{query} |
Yes |
| decryptUpdate(keyId, body, callback) |
Continue multi-part decryption |
{base_path}/{version}/crypto/v1/keys/{pathv1}/decrypt/update?{query} |
Yes |
| decryptUpdateEx(body, callback) |
Continue multi-part decryption |
{base_path}/{version}/crypto/v1/decrypt/update?{query} |
Yes |
| decryptFinal(keyId, body, callback) |
Conclude multi-part decryption |
{base_path}/{version}/crypto/v1/keys/{pathv1}/decrypt/final?{query} |
Yes |
| decryptFinalEx(body, callback) |
Conclude multi-part decryption |
{base_path}/{version}/crypto/v1/decrypt/final?{query} |
Yes |
| sign(keyId, body, callback) |
Sign with a private key |
{base_path}/{version}/crypto/v1/keys/{pathv1}/sign?{query} |
Yes |
| signEx(body, callback) |
Sign with a private key |
{base_path}/{version}/crypto/v1/sign?{query} |
Yes |
| batchSign(body, callback) |
Batch sign with one or more private keys |
{base_path}/{version}/crypto/v1/keys/batch/sign?{query} |
Yes |
| verify(keyId, body, callback) |
Verify a signature with a key |
{base_path}/{version}/crypto/v1/keys/{pathv1}/verify?{query} |
Yes |
| verifyEx(body, callback) |
Verify a signature with a key |
{base_path}/{version}/crypto/v1/verify?{query} |
Yes |
| batchVerify(body, callback) |
Batch verify with one or more private keys |
{base_path}/{version}/crypto/v1/keys/batch/verify?{query} |
Yes |
| computeDigest(body, callback) |
Compute a message digest of data |
{base_path}/{version}/crypto/v1/digest?{query} |
Yes |
| computeMac(keyId, body, callback) |
Compute MAC using a key |
{base_path}/{version}/crypto/v1/keys/{pathv1}/mac?{query} |
Yes |
| computeMacEx(body, callback) |
Compute MAC using a key |
{base_path}/{version}/crypto/v1/mac?{query} |
Yes |
| verifyMac(keyId, body, callback) |
Verify MAC using a key |
{base_path}/{version}/crypto/v1/keys/{pathv1}/macverify?{query} |
Yes |
| verifyMacEx(body, callback) |
Verify MAC using a key |
{base_path}/{version}/crypto/v1/macverify?{query} |
Yes |
| wrapKey(keyId, body, callback) |
Wrap a security object with a key
|
{base_path}/{version}/crypto/v1/keys/{pathv1}/wrapkey?{query} |
Yes |
| wrapKeyEx(body, callback) |
Wrap a security object with a key
|
{base_path}/{version}/crypto/v1/wrapkey?{query} |
Yes |
| unwrapKey(keyId, body, callback) |
Unwrap a security object with a key |
{base_path}/{version}/crypto/v1/keys/{pathv1}/unwrapkey?{query} |
Yes |
| unwrapKeyEx(body, callback) |
Unwrap a security object with a key |
{base_path}/{version}/crypto/v1/unwrapkey?{query} |
Yes |
| getApps(groupId, sort, start, limit, offset, callback) |
Get all applications |
{base_path}/{version}/sys/v1/apps?{query} |
Yes |
| createApp(body, callback) |
Create a new application |
{base_path}/{version}/sys/v1/apps?{query} |
Yes |
| getApp(appId, callback) |
Get a specific application |
{base_path}/{version}/sys/v1/apps/{pathv1}?{query} |
Yes |
| deleteApp(appId, callback) |
Delete application |
{base_path}/{version}/sys/v1/apps/{pathv1}?{query} |
Yes |
| updateApp(appId, body, callback) |
Update an application |
{base_path}/{version}/sys/v1/apps/{pathv1}?{query} |
Yes |
| regenerateApiKey(appId, body, callback) |
Regenerate API key |
{base_path}/{version}/sys/v1/apps/{pathv1}/reset_secret?{query} |
Yes |
| getCredential(appId, callback) |
Get a specific application's credential |
{base_path}/{version}/sys/v1/apps/{pathv1}/credential?{query} |
Yes |
| getGroups(callback) |
Get all groups |
{base_path}/{version}/sys/v1/groups?{query} |
Yes |
| createGroup(body, callback) |
Create new group |
{base_path}/{version}/sys/v1/groups?{query} |
Yes |
| getGroup(groupId, callback) |
Get a specific group |
{base_path}/{version}/sys/v1/groups/{pathv1}?{query} |
Yes |
| deleteGroup(groupId, callback) |
Delete group |
{base_path}/{version}/sys/v1/groups/{pathv1}?{query} |
Yes |
| updateGroup(groupId, body, callback) |
Update group |
{base_path}/{version}/sys/v1/groups/{pathv1}?{query} |
Yes |
| getAccounts(callback) |
Get all accounts |
{base_path}/{version}/sys/v1/accounts?{query} |
Yes |
| createAccount(body, callback) |
Create a new account |
{base_path}/{version}/sys/v1/accounts?{query} |
Yes |
| getAccount(accountId, callback) |
Get a specific account |
{base_path}/{version}/sys/v1/accounts/{pathv1}?{query} |
Yes |
| deleteAccount(accountId, callback) |
Delete account |
{base_path}/{version}/sys/v1/accounts/{pathv1}?{query} |
Yes |
| updateAccount(accountId, body, callback) |
Update account |
{base_path}/{version}/sys/v1/accounts/{pathv1}?{query} |
Yes |
| createChildAccount(body, callback) |
Create a new child account |
{base_path}/{version}/sys/v1/accounts/child?{query} |
Yes |
| getChildAccounts(accountId, callback) |
Get all child accounts of the given account |
{base_path}/{version}/sys/v1/accounts/{pathv1}/child?{query} |
Yes |
| getUsers(groupId, sort, start, limit, offset, callback) |
Get all users |
{base_path}/{version}/sys/v1/users?{query} |
Yes |
| deleteUserAccount(callback) |
Completely delete a user profile from system |
{base_path}/{version}/sys/v1/users?{query} |
Yes |
| createUser(body, callback) |
Create a new user |
{base_path}/{version}/sys/v1/users?{query} |
Yes |
| inviteUser(body, callback) |
Invite a user |
{base_path}/{version}/sys/v1/users/invite?{query} |
Yes |
| getUser(userId, callback) |
Get a specific user |
{base_path}/{version}/sys/v1/users/{pathv1}?{query} |
Yes |
| updateUser(userId, body, callback) |
Update user |
{base_path}/{version}/sys/v1/users/{pathv1}?{query} |
Yes |
| changePassword(body, callback) |
Change user password |
{base_path}/{version}/sys/v1/users/change_password?{query} |
Yes |
| getUserAccount(callback) |
Get account information for the user |
{base_path}/{version}/sys/v1/users/accounts?{query} |
Yes |
| forgotPassword(body, callback) |
Initiate password reset sequence for a user |
{base_path}/{version}/sys/v1/users/forgot_password?{query} |
Yes |
| resetPassword(userId, body, callback) |
Reset a user's password |
{base_path}/{version}/sys/v1/users/{pathv1}/reset_password?{query} |
Yes |
| processInvitations(body, callback) |
Process a user's pending account invitations |
{base_path}/{version}/sys/v1/users/process_invite?{query} |
Yes |
| resendInvitation(userId, callback) |
Resend invite to the user to join a specific account |
{base_path}/{version}/sys/v1/users/{pathv1}/resend_invite?{query} |
Yes |
| deleteUser(userId, callback) |
Removed user's association with an account |
{base_path}/{version}/sys/v1/users/{pathv1}/accounts?{query} |
Yes |
| validatePasswordResetToken(userId, body, callback) |
Validates password reset token for the user |
{base_path}/{version}/sys/v1/users/{pathv1}/validate_token?{query} |
Yes |
| confirmEmail(userId, body, callback) |
Confirms user's email address |
{base_path}/{version}/sys/v1/users/{pathv1}/confirm_email?{query} |
Yes |
| resendConfirmEmail(userId, callback) |
Resend email with link to confirm user's email address |
{base_path}/{version}/sys/v1/users/{pathv1}/resend_confirm_email?{query} |
Yes |
| createChildAccountUser(body, callback) |
Create a new user user in a child account |
{base_path}/{version}/sys/v1/users/child_account?{query} |
Yes |
| getChildAccountUser(userId, callback) |
Get a specific child account user |
{base_path}/{version}/sys/v1/users/child_account/{pathv1}?{query} |
Yes |
| updateChildAccountUser(userId, body, callback) |
Update a child account user |
{base_path}/{version}/sys/v1/users/child_account/{pathv1}?{query} |
Yes |
| deleteChildAccountUser(userId, callback) |
Completely delete a user in child account |
{base_path}/{version}/sys/v1/users/child_account/{pathv1}?{query} |
Yes |
| getAllChildAccountUsers(accountId, callback) |
Get all users in a child account |
{base_path}/{version}/sys/v1/users/child_account/{pathv1}/all?{query} |
Yes |
| getAuditLogs(size, from, actionType = 'Apps', actorType = 'Administrative', actorId, objectId, severity = 'Info', rangeFrom, rangeTo, callback) |
Get audit logs |
{base_path}/{version}/sys/v1/logs?{query} |
Yes |
| getGroupsStats(rangeFrom, rangeTo, topCount, numPoints, callback) |
Get group aggregate transaction statistics |
{base_path}/{version}/sys/v1/stats/groups?{query} |
Yes |
| getAppsStats(rangeFrom, rangeTo, topCount, numPoints, callback) |
Get app aggregate transaction statistics |
{base_path}/{version}/sys/v1/stats/apps?{query} |
Yes |
| getAppStats(appId, rangeFrom, rangeTo, numPoints, callback) |
Get transaction statistics for a specific application |
{base_path}/{version}/sys/v1/stats/{pathv1}/app?{query} |
Yes |
| getGroupStats(groupId, rangeFrom, rangeTo, numPoints, callback) |
Get transaction statistics for a specific group |
{base_path}/{version}/sys/v1/stats/{pathv1}/group?{query} |
Yes |
| getSecurityObjectStats(keyId, rangeFrom, rangeTo, numPoints, callback) |
Get transaction statistics for a specific security object |
{base_path}/{version}/sys/v1/stats/{pathv1}/key?{query} |
Yes |
| authorizeU2F(callback) |
Use a U2F key to complete authentication |
{base_path}/{version}/sys/v1/session/auth/2fa/u2f?{query} |
Yes |
| authorizeRecoveryCode(callback) |
Use a backup recovery code to complete authentication |
{base_path}/{version}/sys/v1/session/auth/2fa/recovery_code?{query} |
Yes |
| generateU2FChallenge(callback) |
Generate a new challenge for registering a U2F devices |
{base_path}/{version}/sys/v1/session/config_2fa/new_challenge?{query} |
Yes |
| lock2F(callback) |
Lock two factor configuration |
{base_path}/{version}/sys/v1/session/config_2fa/terminate?{query} |
Yes |
| generateRecoveryCodes(callback) |
Generate backup recovery codes for the current user |
{base_path}/{version}/sys/v1/users/generate_recovery_code?{query} |
Yes |
| getPlugins(groupId, sort, start, limit, offset, callback) |
Get all plugins |
{base_path}/{version}/sys/v1/plugins?{query} |
Yes |
| createPlugin(body, callback) |
Create a new plugin |
{base_path}/{version}/sys/v1/plugins?{query} |
Yes |
| getPlugin(pluginId, callback) |
Get a specific plugin |
{base_path}/{version}/sys/v1/plugins/{pathv1}?{query} |
Yes |
| deletePlugin(pluginId, callback) |
Delete plugin |
{base_path}/{version}/sys/v1/plugins/{pathv1}?{query} |
Yes |
| updatePlugin(pluginId, body, callback) |
Update a plugin |
{base_path}/{version}/sys/v1/plugins/{pathv1}?{query} |
Yes |
| invokePlugin(pluginId, body, callback) |
Invoke a plugin |
{base_path}/{version}/sys/v1/plugins/{pathv1}?{query} |
Yes |
| getSysV1PluginsInvokePluginId(pluginId, callback) |
Invoke a plugin using GET. |
{base_path}/{version}/sys/v1/plugins/invoke/{pathv1}?{query} |
Yes |
| getApprovalRequests(requester, reviewer, subject, status = 'PENDING', callback) |
Get all approval requests |
{base_path}/{version}/sys/v1/approval_requests?{query} |
Yes |
| createApprovalRequest(body, callback) |
Create approval request |
{base_path}/{version}/sys/v1/approval_requests?{query} |
Yes |
| getApprovalRequest(requestId, callback) |
Get an approval request. |
{base_path}/{version}/sys/v1/approval_requests/{pathv1}?{query} |
Yes |
| deleteApprovalRequest(requestId, callback) |
Delete an approval request. |
{base_path}/{version}/sys/v1/approval_requests/{pathv1}?{query} |
Yes |
| approve(requestId, callback) |
Approve a request. |
{base_path}/{version}/sys/v1/approval_requests/{pathv1}/approve?{query} |
Yes |
| deny(requestId, callback) |
Deny a request. |
{base_path}/{version}/sys/v1/approval_requests/{pathv1}/deny?{query} |
Yes |
| getResult(requestId, callback) |
Get the result for an approved or failed request. |
{base_path}/{version}/sys/v1/approval_requests/{pathv1}/result?{query} |
Yes |
| getPortInfoUsingGET2(callback) |
Fetch List of Virtual Ports. |
{base_path}/{version}/ecx/v3/port/userport?{query} |
Yes |
| getPostStatUsingGET(portUUID, startDate, endDate, callback) |
Get port utilization stats |
{base_path}/{version}/ecx/v3/stats/port/{pathv1}?{query} |
Yes |
| getAllBuyerConnectionsUsingGET(authorizationKey, status = 'PENDING_APPROVAL', metroCode, buyerPortName, buyerPortUUID, searchType = 'AND', subAccount, pageNumber, pageSize, callback) |
Get all my connections |
{base_path}/{version}/ecx/v3/l2/buyer/connections?{query} |
Yes |
| getL2PricesUsingGET(destinationMetro, customSpeeds, portUUID, callback) |
Get Layer 2 connection pricing |
{base_path}/{version}/ecx/v3/l2/connections/prices?{query} |
Yes |
| getBuyerPreferenceUsingGET(callback) |
Get bandwidth alert preference |
{base_path}/{version}/ecx/v3/l2/buyerPreference?{query} |
Yes |
| saveBuyerPreferenceUsingPOST(request, callback) |
Create bandwidth alert preference |
{base_path}/{version}/ecx/v3/l2/buyerPreference?{query} |
Yes |
| updateBuyerPreferenceUsingPUT(request, callback) |
Update bandwidth alert preference |
{base_path}/{version}/ecx/v3/l2/buyerPreference?{query} |
Yes |
| deleteBuyerPreferenceUsingDELETE(callback) |
Delete bandwidth alert preference |
{base_path}/{version}/ecx/v3/l2/buyerPreference?{query} |
Yes |
| getAllSellerProfileUsingGET(pageNumber, pageSize, state = 'PENDING_APPROVAL', callback) |
Get all service profiles |
{base_path}/{version}/ecx/v3/l2/serviceprofiles?{query} |
Yes |
| createServiceProfileUsingPOST(profileModel, callback) |
Create Layer 2 Service profile |
{base_path}/{version}/ecx/v3/l2/serviceprofiles?{query} |
Yes |
| updateL2ServiceProfileUsingPUT(profileModel, callback) |
Update Layer 2 Service profile |
{base_path}/{version}/ecx/v3/l2/serviceprofiles?{query} |
Yes |
| validateIntegrationIdUsingGET(integrationId, callback) |
Validate integration id |
{base_path}/{version}/ecx/v3/l2/serviceprofiles/validateIntegrationId/{pathv1}?{query} |
Yes |
| deleteProfileByProfileNameOrUUIDUsingDELETE(uuid, callback) |
Delete service profile by uuid |
{base_path}/{version}/ecx/v3/l2/serviceprofiles/{pathv1}?{query} |
Yes |
| getProfileByIdOrNameUsingGET(uuid, callback) |
Get service profiles |
{base_path}/{version}/ecx/v3/l2/serviceprofiles/{pathv1}?{query} |
Yes |
| getSellerConnectionsUsingGET(status = 'PROVISIONED', metroCode, portName, state, profileId, pageNumber, pageSize, callback) |
Get all of my connections |
{base_path}/{version}/ecx/v3/l2/seller/connections?{query} |
Yes |
| getAlarmV1SmartviewAlarms(accountNo, limit, offset, groupByIBX, callback) |
Find all the active alarms. |
{base_path}/{version}/alarm/v1/smartview/alarms?{query} |
Yes |
| getAlerts(ibx, category, eventType, accountNo, pageNum, limit, orderBy, sortBy, callback) |
obtain active SmartView alerts. |
{base_path}/{version}/smartview/v1/alerts/getAlerts?{query} |
Yes |
| getAlertActivityLog(ibx, category, eventType, isAcknowledged, accountNo, pageNum, limit, orderBy, sortBy, callback) |
get alert activity logs |
{base_path}/{version}/smartview/v1/alerts/getAlertActivityLog?{query} |
Yes |
| getAsset(accountNo, ibx, classification = 'Electrical', cages, callback) |
get assets list information |
{base_path}/{version}/smartview/v1/asset/list?{query} |
Yes |
| getAssetDetails(accountNo, ibx, classification, assetId, callback) |
get details for an asset. |
{base_path}/{version}/smartview/v1/asset/details?{query} |
Yes |
| postSmartviewV1AssetDetails(payload, callback) |
get asset details |
{base_path}/{version}/smartview/v1/asset/details?{query} |
Yes |
| getAffectedAsset(accountNo, ibx, assetId, classification = 'Electrical', callback) |
get affected customers assets hierarchy |
{base_path}/{version}/smartview/v1/asset/tagpoint/affected-assets?{query} |
Yes |
| searchAsset(accountNo, ibx, searchString, callback) |
Search for Assets matching identifiers |
{base_path}/{version}/smartview/v1/asset/search?{query} |
Yes |
| getCurrentTagPoint(accountNo, ibx, tagid, callback) |
obtain latest tag point data |
{base_path}/{version}/smartview/v1/asset/tagpoint/current?{query} |
Yes |
| postSmartviewV1AssetTagpointCurrent(payload, callback) |
get current tag points data |
{base_path}/{version}/smartview/v1/asset/tagpoint/current?{query} |
Yes |
| getTagpointTrending(accountNo, ibx, tagid, interval, fromDate, toDate, callback) |
obtain trending tag point data |
{base_path}/{version}/smartview/v1/asset/tagpoint/trending?{query} |
Yes |
| getEnvironmentV1Current(accountNo, ibx, levelType = 'IBX', levelValue, callback) |
Get current environmental data |
{base_path}/{version}/environment/v1/current?{query} |
Yes |
| getEnvironmentV1ListCurrent(accountNo, ibx, levelType = 'IBX', callback) |
Fetch list of environmental data |
{base_path}/{version}/environment/v1/listCurrent?{query} |
Yes |
| getEnvironmentV1Trending(accountNo, ibx, dataPoint = 'temperature', levelType = 'IBX', levelValue, interval = 'reading', fromDate, toDate, callback) |
Fetch trending environmental data |
{base_path}/{version}/environment/v1/trending?{query} |
Yes |
| getLocationHierarchy(accountNo, ibx, callback) |
Fetch the Location Hierarchy |
{base_path}/{version}/smartview/v1/hierarchy/location?{query} |
Yes |
| getPowerHierarchy(accountNo, ibx, callback) |
Fetch the Power Hierarchy |
{base_path}/{version}/smartview/v1/hierarchy/power?{query} |
Yes |
| getPowerV1Current(accountNo, ibx, levelType = 'ibx', levelValue, callback) |
Fetch current power consumption data |
{base_path}/{version}/power/v1/current?{query} |
Yes |
| postPowerV1Current(body, callback) |
Fetch current power consumption data |
{base_path}/{version}/power/v1/current?{query} |
Yes |
| getPowerV1Trending(accountNo, ibx, levelType = 'ibx', levelValue, interval, fromDate, toDate, callback) |
Fetch Trending Power Data.
|
{base_path}/{version}/power/v1/trending?{query} |
Yes |
| getSensorReadings(ibx, type, zone, offset, limit, callback) |
IBX sensors current readings |
{base_path}/{version}/smartview/v2/environmental/ibxs/{pathv1}/sensors/readings?{query} |
Yes |
| getSingleSensorReadings(ibx, sensorId, callback) |
Single sensor current value(s) |
{base_path}/{version}/smartview/v2/environmental/ibxs/{pathv1}/sensors/{pathv2}/readings?{query} |
Yes |
| searchAssets(sorts, source, q, exactMatch, offset, limit, body, callback) |
Search permissible assets |
{base_path}/{version}/v1/assets/search?{query} |
Yes |
| getAssetById(assetId, callback) |
Get details of an asset |
{base_path}/{version}/v1/assets/{pathv1}?{query} |
Yes |
| createAttachment(uploadFile, purpose = 'LOA', callback) |
Upload attachment file |
{base_path}/{version}/v1/attachments/file?{query} |
Yes |
| deleteAttachment(attachmentId, callback) |
Delete attachments by identifier |
{base_path}/{version}/v1/attachments/{pathv1}?{query} |
Yes |
| getCrossConnectProviders(crossConnectType = 'STANDARD', ibx, cage, account, connectTo = 'SELF', callback) |
Get Cross Connect Providers |
{base_path}/{version}/v1/orders/crossconnect/providers?{query} |
Yes |
| getCrossConnectLocations(ibxs, crossConnectType = 'STANDARD', cages, detail, side = 'A_SIDE', asideIbx, accountNumber, callback) |
Get Cross Connect Locations |
{base_path}/{version}/v1/orders/crossconnect/locations?{query} |
Yes |
| getCrossConnectTypes(callback) |
Get Cross Connect Types |
{base_path}/{version}/v1/orders/crossconnect/types?{query} |
Yes |
| getCrossconnectConnectionServices(ibx, side = 'A_SIDE', asideIbx, providerAccountNo, crossConnectType = 'STANDARD', callback) |
Get Cross Connect Connection Services |
{base_path}/{version}/v1/orders/crossconnect/connectionservices?{query} |
Yes |
| getCrossConnectPatchPanel(name, ibx, cage, cabinet, legacyName, mediaType, side = 'A_SIDE', asideIbx, providerAccountNo, accountNumber, crossConnectType = 'STANDARD', callback) |
Get Cross Connect Patch panel |
{base_path}/{version}/v1/orders/crossconnect/patchpanel?{query} |
Yes |
| postCrossConnectStandard(action = 'SUBMIT', body, callback) |
Order Standard Cross Connect |
{base_path}/{version}/v1/orders/crossconnect/standard?{query} |
Yes |
| postCrossConnectsStandard(action = 'SUBMIT', body, callback) |
Order Multiple Cross Connects |
{base_path}/{version}/v1/orders/crossconnects?{query} |
Yes |
| getBillingAccounts(offset, limit, sorts = 'ACCOUNT_NUMBER', callback) |
Get billing accounts summary |
{base_path}/{version}/v1/finance/accounts?{query} |
Yes |
| downloadBillingDocument(accountNumber, invoiceId, documentId, callback) |
Download specific invoice document |
{base_path}/{version}/v1/finance/accounts/{pathv1}/{pathv2}?{query} |
Yes |
| getBillingAccountByNumber(accountNumber, months, callback) |
Get specific billing account summary |
{base_path}/{version}/v1/finance/accounts/{pathv1}?{query} |
Yes |
| searchIbxNotifications(offset, limit, sorts, body, callback) |
Ibx Notifications Search |
{base_path}/{version}/v1/notifications/ibx/search?{query} |
Yes |
| getIbxNotification(id, callback) |
Get Ibx Notification |
{base_path}/{version}/v1/notifications/ibx/{pathv1}?{query} |
Yes |
| searchNetworkNotifications(offset, limit, sorts, body, callback) |
Network Notifications Search |
{base_path}/{version}/v1/notifications/network/search?{query} |
Yes |
| getNetworkNotification(id, callback) |
Get Network Notification |
{base_path}/{version}/v1/notifications/network/{pathv1}?{query} |
Yes |
| getRetrieveOrdersLocations(callback) |
Retrieve order permissible IBX locations |
{base_path}/{version}/v1/retrieve-orders/locations?{query} |
Yes |
| postOrdersHistory(body, callback) |
Search Orders History |
{base_path}/{version}/v1/retrieve-orders?{query} |
Yes |
| scheduleReport(body, callback) |
Schedule New Report |
{base_path}/{version}/v1/reportCenter/reports/scheduler?{query} |
Yes |
| getScheduledReports(offset, limit, sorts, callback) |
Get your Scheduled Reports |
{base_path}/{version}/v1/reportCenter/reports/scheduler?{query} |
Yes |
| deleteScheduledReports(scheduledIds, callback) |
Delete your scheduled reports |
{base_path}/{version}/v1/reportCenter/reports/scheduler?{query} |
Yes |
| downloadReports(reportIds, callback) |
Download list of generated reports |
{base_path}/{version}/v1/reportCenter/reports/files?{query} |
Yes |
| getScheduledReport(scheduledId, callback) |
Get details of scheduled report |
{base_path}/{version}/v1/reportCenter/reports/scheduler/{pathv1}?{query} |
Yes |
| updateScheduledReport(scheduledId, body, callback) |
Modify scheduled report parameters |
{base_path}/{version}/v1/reportCenter/reports/scheduler/{pathv1}?{query} |
Yes |
| getReportDefinitions(callback) |
Get all reports definitions |
{base_path}/{version}/v1/reportCenter/reports/definitions?{query} |
Yes |
| deleteReports(reportIds, callback) |
Delete your generated reports |
{base_path}/{version}/v1/reportCenter/reports?{query} |
Yes |
| getReports(offset, limit, duration, sorts, statuses, callback) |
Get your generated reports |
{base_path}/{version}/v1/reportCenter/reports?{query} |
Yes |
| generateReport(scheduledId, callback) |
Generate new report from schedule |
{base_path}/{version}/v1/reportCenter/reports/scheduler/{pathv1}/report?{query} |
Yes |
| getReportDefinition(reportName, callback) |
Get report definition by name |
{base_path}/{version}/v1/reportCenter/reports/definitions/{pathv1}?{query} |
Yes |
| downloadReport(reportId, callback) |
Download a generated report |
{base_path}/{version}/v1/reportCenter/reports/{pathv1}/file?{query} |
Yes |
| getReportById(reportId, callback) |
Get details of generated report |
{base_path}/{version}/v1/reportCenter/reports/{pathv1}?{query} |
Yes |
| outboundShipmentSubmit(body, callback) |
Schedule outbound shipment |
{base_path}/{version}/v1/orders/shipment/outbound?{query} |
Yes |
| getLocation(detail, ibxs, cages, callback) |
Get Shipment Locations |
{base_path}/{version}/v1/orders/shipment/locations?{query} |
Yes |
| shipmentInbound(body, callback) |
Schedule inbound shipment |
{base_path}/{version}/v1/orders/shipment/inbound?{query} |
Yes |
| shipmentPending(body, callback) |
Schedule pending inbound shipment |
{base_path}/{version}/v1/orders/shipment/pendingStorage?{query} |
Yes |
| handleSmartHandOrder(body, callback) |
Order Smarthands Equipment Install |
{base_path}/{version}/v1/orders/smarthands/equipmentInstall?{query} |
Yes |
| handleSmartHandShipmentUnpackOrder(body, callback) |
Order Smarthands Shipment Unpack |
{base_path}/{version}/v1/orders/smarthands/shipmentUnpack?{query} |
Yes |
| handleSmartHandMoveJumperCableOrder(body, callback) |
Order Smarthands Move Jumper Cable |
{base_path}/{version}/v1/orders/smarthands/moveJumperCable?{query} |
Yes |
| handleSmartHandCageEscortOrder(body, callback) |
Order Smarthands Cage Escort |
{base_path}/{version}/v1/orders/smarthands/cageEscort?{query} |
Yes |
| handleSmartHandLocatePackageOrder(body, callback) |
Order Smarthands Locate Package |
{base_path}/{version}/v1/orders/smarthands/locatePackage?{query} |
Yes |
| handleSmartHandPicturesDocumentOrder(body, callback) |
Order Smarthands Pictures Document |
{base_path}/{version}/v1/orders/smarthands/picturesDocument?{query} |
Yes |
| handleSmartHandPatchCableInstallOrder(body, callback) |
Order Smarthands Patch Cable Install |
{base_path}/{version}/v1/orders/smarthands/patchCableInstall?{query} |
Yes |
| handleSmartHandPatchCableRemovalOrder(body, callback) |
Order Smarthands Patch Cable Removal |
{base_path}/{version}/v1/orders/smarthands/patchCableRemoval?{query} |
Yes |
| handleSmartHandCageCleanupOrder(body, callback) |
Order Smarthands Cage Cleanup |
{base_path}/{version}/v1/orders/smarthands/cageCleanup?{query} |
Yes |
| handleSmartHandCableRequestOrder(body, callback) |
Order Smarthands Cable Request |
{base_path}/{version}/v1/orders/smarthands/cableRequest?{query} |
Yes |
| handleSmartHandRunJumperCableOrder(body, callback) |
Order Smarthands Run Jumper Cable |
{base_path}/{version}/v1/orders/smarthands/runJumperCable?{query} |
Yes |
| handleSmartHandOthersOrder(body, callback) |
Order Smarthands Other |
{base_path}/{version}/v1/orders/smarthands/other?{query} |
Yes |
| smartHandTypes(callback) |
Get Smart Hands Types |
{base_path}/{version}/v1/orders/smarthands/types?{query} |
Yes |
| getTroubleTicketType(category = 'Cross Connect', callback) |
Get Trouble Ticket Types |
{base_path}/{version}/v1/orders/troubleticket/types?{query} |
Yes |
| placeTroubleTicketOrder(body, callback) |
Order Trouble ticket |
{base_path}/{version}/v1/orders/troubleticket?{query} |
Yes |
| searchUser(q, filters, searchType = 'CONTAINS', statuses, favoriteOnly, forOrg, permissions, permissibleIbxs, permissibleCages, roles, offset, limit, sorts, isOnboarded, hasPortalAccess, isManageable, excludeSelf, callback) |
Search Users in Organization |
{base_path}/{version}/v1/users?{query} |
Yes |
| workVisitOrder(body, callback) |
Schedule Work Visit |
{base_path}/{version}/v1/orders/workvisit?{query} |
Yes |