{ "opencollection": "1.0.0", "info": { "name": "Blue API reference Admin API", "version": "v1" }, "items": [ { "info": { "name": "Admin", "type": "folder" }, "items": [ { "info": { "name": "Lists all account groups.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/acctgroups" }, "docs": "Lists all account groups." }, { "info": { "name": "Gets an account group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/acctgroups/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Gets an account group." }, { "info": { "name": "WORK-IN-PROGRESS: Exports audit logs for login user's organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/auditlogs:export" }, "docs": "WORK-IN-PROGRESS: Exports audit logs for login user's organization." }, { "info": { "name": "WORK-IN-PROGRESS: Configure AWS Proforma Cost and Usage Report.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/reports/proforma" }, "docs": "WORK-IN-PROGRESS: Configure AWS Proforma Cost and Usage Report." }, { "info": { "name": "WORK-IN-PROGRESS: Gets a CloudFormation launch URL for enabling CloudWatch metrics streaming on a target account.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/cwms" }, "docs": "WORK-IN-PROGRESS: Gets a CloudFormation launch URL for enabling CloudWatch metrics streaming on a target account." }, { "info": { "name": "WORK-IN-PROGRESS: Starts validation of a CloudWatch Metrics streaming stack deployment.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/cwms" }, "docs": "WORK-IN-PROGRESS: Starts validation of a CloudWatch Metrics streaming stack deployment." }, { "info": { "name": "Gets a CloudFormation launch URL for enabling the default cross-account access to your account's cost information based on type. See comments on the type for more information on what each template does.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/dca", "params": [ { "name": "type", "value": "", "type": "query", "description": "Optional. Valid values are `default`, `s3only`, and `apionly`. Defaults to `default` if empty.\n\n`default` - Template for setting up both CUR export and read-only access to cost information. If selected, you need to deploy this template to `us-east-1` region as CloudFormation only supports the `AWS::CUR::ReportDefinition` in that region at the moment. The target S3 bucket will also be created in that region. If you prefer your S3 bucket to be located in a different region, you can use the template from this API by setting the type to `s3only`. After your S3 bucket is ready, call this API again (type is `default`) and set the `CurS3BucketOption` parameter to `USE_EXISTING`, then set your bucket name and region accordingly. This is the default for Ripple, unless specified otherwise.\n\n`apionly` - Template for setting up ready-only access to cost information. Handy if you already have exported your CUR to Alphaus through other means (i.e. manual setup). This template is the same as the `default` type but without the CUR export definitions. Although not required, we recommend you to deploy this template to allow us to query your cost-related information such as Reserved Instances, Saving Plans, etc. through the AWS API. At the moment, we only rely on CUR data which is a best-effort basis and sometimes not accurate. This is the default for Wave(Pro), unless specified otherwise.\n\n`s3only` - A helper template for creating an S3 bucket to be used for CUR export.\n\n`default-2.0`- For default cur 2.0 templates. \n\n`s3only-2.0` - For s3only cur 2.0 templates.\n\nAll templates are publicly available from the reponse link (`templateUrl`) if you want to audit the included permissions." } ] }, "docs": "Gets a CloudFormation launch URL for enabling the default cross-account access to your account's cost information based on type. See comments on the type for more information on what each template does." }, { "info": { "name": "Starts validation of a default cross-account access stack deployment. If successful, the IAM role created from the CloudFormation stack will be registered to the target.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/dca" }, "docs": "Starts validation of a default cross-account access stack deployment. If successful, the IAM role created from the CloudFormation stack will be registered to the target." }, { "info": { "name": "Lists the default cross-account access role(s) attached to accounts under caller.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/dca/all:read" }, "docs": "Lists the default cross-account access role(s) attached to accounts under caller." }, { "info": { "name": "Gets the current default cross-account role attached to the input target.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/dca/:target", "params": [ { "name": "target", "value": "", "type": "path", "description": "Required. The target AWS account to query." } ] }, "docs": "Gets the current default cross-account role attached to the input target." }, { "info": { "name": "Starts an update to an existing default cross-account access CloudFormation stack for template changes, if any. Only call this API if the status of your default cross-account access is 'outdated'.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/dca/:target", "params": [ { "name": "target", "value": "", "type": "path", "description": "Required. The target AWS account to update." } ] }, "docs": "Starts an update to an existing default cross-account access CloudFormation stack for template changes, if any. Only call this API if the status of your default cross-account access is 'outdated'." }, { "info": { "name": "Deletes the current default cross-account access role attached to this target account. This does not delete the CloudFormation deployment in your account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/admin/v1/aws/xacct/dca/:target", "params": [ { "name": "target", "value": "", "type": "path", "description": "Required. The target AWS account to delete." } ] }, "docs": "Deletes the current default cross-account access role attached to this target account. This does not delete the CloudFormation deployment in your account." }, { "info": { "name": "WORK-IN-PROGRESS: Set the default meta saved per organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/admin/v1/defaultmeta" }, "docs": "WORK-IN-PROGRESS: Set the default meta saved per organization" }, { "info": { "name": "WORK-IN-PROGRESS: Fetch the default meta saved per organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/defaultmeta/:mspId", "params": [ { "name": "mspId", "value": "", "type": "path" } ] }, "docs": "WORK-IN-PROGRESS: Fetch the default meta saved per organization" }, { "info": { "name": "Lists all notification channels for login user's organization or group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/channels" }, "docs": "Lists all notification channels for login user's organization or group." }, { "info": { "name": "WORK-IN-PROGRESS: Creates notification settings for login user's organization or group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/channels" }, "docs": "WORK-IN-PROGRESS: Creates notification settings for login user's organization or group." }, { "info": { "name": "Gets notification channel for login user's organization or group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/channels/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional." } ] }, "docs": "Gets notification channel for login user's organization or group." }, { "info": { "name": "WORK-IN-PROGRESS: Updates notification settings for login user's organization or group.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/channels/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required. ID of the notification channel to update." } ] }, "docs": "WORK-IN-PROGRESS: Updates notification settings for login user's organization or group." }, { "info": { "name": "Deletes notification settings for login user's organization or group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/channels/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required. ID of the notification channel to delete." } ] }, "docs": "Deletes notification settings for login user's organization or group." }, { "info": { "name": "Creates a default notification channel of type email based on the caller's primary email address.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/default" }, "docs": "Creates a default notification channel of type email based on the caller's primary email address." }, { "info": { "name": "Get notification settings for login user's organization or group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/settings" }, "docs": "Get notification settings for login user's organization or group." }, { "info": { "name": "Creates or updates notification settings for login user's organization or group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notification/settings" }, "docs": "Creates or updates notification settings for login user's organization or group." }, { "info": { "name": "WORK-IN-PROGRESS: List all notification for login user's organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notifications" }, "docs": "WORK-IN-PROGRESS: List all notification for login user's organization." }, { "info": { "name": "WORK-IN-PROGRESS: Creates notification for login user's organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notifications" }, "docs": "WORK-IN-PROGRESS: Creates notification for login user's organization." }, { "info": { "name": "WORK-IN-PROGRESS: Get notifications for login user's organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required" }, { "name": "notificationType", "value": "", "type": "query", "description": "Required\nValid values:\n`InvoiceCalculationStarted`,\n`InvoiceCalculationFinished`,\n`CurUpdatedAfterInvoice`.\n`AccountBudgetAlert`." } ] }, "docs": "WORK-IN-PROGRESS: Get notifications for login user's organization." }, { "info": { "name": "WORK-IN-PROGRESS: Updates notification for login user's organization.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required" } ] }, "docs": "WORK-IN-PROGRESS: Updates notification for login user's organization." }, { "info": { "name": "WORK-IN-PROGRESS: Deletes notification for login user's organization.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/admin/v1/notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required" }, { "name": "notificationType", "value": "", "type": "query", "description": "Required\nValid values:\n`InvoiceCalculationStarted`,\n`InvoiceCalculationFinished`,\n`CurUpdatedAfterInvoice`.\n`AccountBudgetAlert`." } ] }, "docs": "WORK-IN-PROGRESS: Deletes notification for login user's organization." }, { "info": { "name": "WORK-IN-PROGRESS: Get settings value for wave features management per organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/admin/v1/wavefeatures", "params": [ { "name": "lang", "value": "", "type": "query" } ] }, "docs": "WORK-IN-PROGRESS: Get settings value for wave features management per organization" }, { "info": { "name": "WORK-IN-PROGRESS: Updates the wave feature management default value per organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/admin/v1/wavefeatures" }, "docs": "WORK-IN-PROGRESS: Updates the wave feature management default value per organization" } ] } ], "bundled": true }