Skip to content

Latest commit

 

History

History
171 lines (118 loc) · 4.63 KB

Website.md

File metadata and controls

171 lines (118 loc) · 4.63 KB
Raw

Website

Method HTTP request
deploy POST /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy
get GET /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website
undeploy POST /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy

deploy

Deploy a version of the Website.

Parameters

Name Type Description Notes
third_party_application_rid ThirdPartyApplicationRid thirdPartyApplicationRid
version VersionVersion

Return type

Website

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# ThirdPartyApplicationRid | thirdPartyApplicationRid
third_party_application_rid = (
    "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6"
)
# VersionVersion |
version = "1.2.0"


try:
    api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.deploy(
        third_party_application_rid,
        version=version,
    )
    print("The deploy response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Website.deploy: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Website application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

Get the Website.

Parameters

Name Type Description Notes
third_party_application_rid ThirdPartyApplicationRid thirdPartyApplicationRid

Return type

Website

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# ThirdPartyApplicationRid | thirdPartyApplicationRid
third_party_application_rid = (
    "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6"
)


try:
    api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.get(
        third_party_application_rid,
    )
    print("The get response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Website.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Website application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

undeploy

Remove the currently deployed version of the Website.

Parameters

Name Type Description Notes
third_party_application_rid ThirdPartyApplicationRid thirdPartyApplicationRid

Return type

Website

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# ThirdPartyApplicationRid | thirdPartyApplicationRid
third_party_application_rid = (
    "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6"
)


try:
    api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.undeploy(
        third_party_application_rid,
    )
    print("The undeploy response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling Website.undeploy: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Website application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]