CreateSponsoredLinkOptions

This request returns a list of environment policies and users that can be used to create sponsored environments (with the CreateSponsoredLink request). An environment policy is a combination of project and blueprint, both of which are necessary to use an environment.

The list can be filtered by project, blueprint or environment policy duration, using parameters included with the request. If no parameters are included in the request, all environment polices available to the user are returned.

Request URL

GET https://use.cloudshare.com/Api/v2/Admin/CreateSponsoredLinkOptions?projectFilter=<project>&blueprintFilter=<blueprint>&envPolicyDurationFilter=<policy>&token=<token>×tamp=<time>&UserApiId=<id>&HMAC=<signature>

Parameters

projectFilter
optional
A name of a specific project, to filter the result list.
Example: Automation
blueprintFilter
optional
A name of a specific blueprint, to filter the result list.
Example: automation
envPolicyDurationFilter
optional
A name of a specific environment policy duration to filter the result list.
Example: Automation (5d)

Response example

If the request is successful (status_code is 0x20000) a list of users (Owning Project Members) and a list of environment policies are returned.

{
    "data": {
        "AvailableOwningProjectMembersList": [
            {
                "Email": "jsmith@company.com",
                "Name": "j smith",
                "Organizations": [
                    "CloudShare"
                ],
                "OwningProjectMemberId": "MHURFL02DNVB"
            }
        ],
        "EnvPoliciesList": [
            {
                "Blueprints": [
                    {
                        "BlueprintId": "TXRICZURB1TA",
                        "Name": "CloudShare linux proto"
                    }
                ],
                "EnvPolicyDuration": "PoC (10 days)",
                "EnvPolicyId": "T0JCP2VQ1XHA",
                "Organizations": [
                    "CloudShare"
                ],
                "Project": "Linux Project"
            },
            {
                "Blueprints": [
                    {
                        "BlueprintId": "LWD0GW52CEJA",
                        "Name": "linux environment"
                    }
                ],
                "EnvPolicyDuration": "PoC (10 days)",
                "EnvPolicyId": "GSMKV44JETNA",
                "Organizations": [
                    "CloudShare"
                ],
                "Project": "Linux Project"
            },
        ]
    },
    "remaining__calls": 99992,
    "status_additional_data": null,
    "status_code": "0x20000",
    "status_text": "Success"
}

If the request is unsuccessful, the status_code and status_text fields in the response will indicate the problem.