Note: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
POST https://api.ap1.datadoghq.com/api/v2/forms/{form_id}/publishhttps://api.ap2.datadoghq.com/api/v2/forms/{form_id}/publishhttps://api.datadoghq.eu/api/v2/forms/{form_id}/publishhttps://api.ddog-gov.com/api/v2/forms/{form_id}/publishhttps://api.us2.ddog-gov.com/api/v2/forms/{form_id}/publishhttps://api.uk1.datadoghq.com/api/v2/forms/{form_id}/publishhttps://api.datadoghq.com/api/v2/forms/{form_id}/publishhttps://api.us3.datadoghq.com/api/v2/forms/{form_id}/publishhttps://api.us5.datadoghq.com/api/v2/forms/{form_id}/publish
Overview
Publish a specific version of a form, making it available for submissions.
Arguments
Path Parameters
Request
Body Data (required)
Response
Code Example
// Publish a form version returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
"github.com/google/uuid"
)
func main() {
// there is a valid "form" in the system
FormDataID := uuid.MustParse(os.Getenv("FORM_DATA_ID"))
body := datadogV2.PublishFormRequest{
Data: datadogV2.PublishFormData{
Attributes: datadogV2.PublishFormDataAttributes{
Version: 1,
},
Type: datadogV2.FORMPUBLICATIONTYPE_FORM_PUBLICATIONS,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.PublishForm", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewFormsApi(apiClient)
resp, r, err := api.PublishForm(ctx, FormDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `FormsApi.PublishForm`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `FormsApi.PublishForm`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Publish a form version returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.FormsApi;
import com.datadog.api.client.v2.model.FormPublicationResponse;
import com.datadog.api.client.v2.model.FormPublicationType;
import com.datadog.api.client.v2.model.PublishFormData;
import com.datadog.api.client.v2.model.PublishFormDataAttributes;
import com.datadog.api.client.v2.model.PublishFormRequest;
import java.util.UUID;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.publishForm", true);
FormsApi apiInstance = new FormsApi(defaultClient);
// there is a valid "form" in the system
UUID FORM_DATA_ID = null;
try {
FORM_DATA_ID = UUID.fromString(System.getenv("FORM_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}
PublishFormRequest body =
new PublishFormRequest()
.data(
new PublishFormData()
.attributes(new PublishFormDataAttributes().version(1L))
.type(FormPublicationType.FORM_PUBLICATIONS));
try {
FormPublicationResponse result = apiInstance.publishForm(FORM_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FormsApi#publishForm");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
"""
Publish a form version returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.forms_api import FormsApi
from datadog_api_client.v2.model.form_publication_type import FormPublicationType
from datadog_api_client.v2.model.publish_form_data import PublishFormData
from datadog_api_client.v2.model.publish_form_data_attributes import PublishFormDataAttributes
from datadog_api_client.v2.model.publish_form_request import PublishFormRequest
# there is a valid "form" in the system
FORM_DATA_ID = environ["FORM_DATA_ID"]
body = PublishFormRequest(
data=PublishFormData(
attributes=PublishFormDataAttributes(
version=1,
),
type=FormPublicationType.FORM_PUBLICATIONS,
),
)
configuration = Configuration()
configuration.unstable_operations["publish_form"] = True
with ApiClient(configuration) as api_client:
api_instance = FormsApi(api_client)
response = api_instance.publish_form(form_id=FORM_DATA_ID, body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Publish a form version returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.publish_form".to_sym] = true
end
api_instance = DatadogAPIClient::V2::FormsAPI.new
# there is a valid "form" in the system
FORM_DATA_ID = ENV["FORM_DATA_ID"]
body = DatadogAPIClient::V2::PublishFormRequest.new({
data: DatadogAPIClient::V2::PublishFormData.new({
attributes: DatadogAPIClient::V2::PublishFormDataAttributes.new({
version: 1,
}),
type: DatadogAPIClient::V2::FormPublicationType::FORM_PUBLICATIONS,
}),
})
p api_instance.publish_form(FORM_DATA_ID, body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Publish a form version returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_forms::FormsAPI;
use datadog_api_client::datadogV2::model::FormPublicationType;
use datadog_api_client::datadogV2::model::PublishFormData;
use datadog_api_client::datadogV2::model::PublishFormDataAttributes;
use datadog_api_client::datadogV2::model::PublishFormRequest;
#[tokio::main]
async fn main() {
// there is a valid "form" in the system
let form_data_id =
uuid::Uuid::parse_str(&std::env::var("FORM_DATA_ID").unwrap()).expect("Invalid UUID");
let body = PublishFormRequest::new(PublishFormData::new(
PublishFormDataAttributes::new(1),
FormPublicationType::FORM_PUBLICATIONS,
));
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.PublishForm", true);
let api = FormsAPI::with_config(configuration);
let resp = api.publish_form(form_data_id.clone(), body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Publish a form version returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
configuration.unstableOperations["v2.publishForm"] = true;
const apiInstance = new v2.FormsApi(configuration);
// there is a valid "form" in the system
const FORM_DATA_ID = process.env.FORM_DATA_ID as string;
const params: v2.FormsApiPublishFormRequest = {
body: {
data: {
attributes: {
version: 1,
},
type: "form_publications",
},
},
formId: FORM_DATA_ID,
};
apiInstance
.publishForm(params)
.then((data: v2.FormPublicationResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"