--- title: Actualizar una API description: Actualiza la información sobre una API específica. breadcrumbs: Documentación > API > Actualizar una API --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # Actualizar una API ## v2 (deprecated) {% alert level="warning" %} **Note**: This endpoint is deprecated. {% /alert %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------- | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v2/apicatalog/api/{id}/openapi | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v2/apicatalog/api/{id}/openapi | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v2/apicatalog/api/{id}/openapi | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v2/apicatalog/api/{id}/openapi | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v2/apicatalog/api/{id}/openapi | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v2/apicatalog/api/{id}/openapi | | uk1.datadoghq.com | PUT https://api.uk1.datadoghq.com/api/v2/apicatalog/api/{id}/openapi | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v2/apicatalog/api/{id}/openapi | | us2.ddog-gov.com | PUT https://api.us2.ddog-gov.com/api/v2/apicatalog/api/{id}/openapi | ### Overview Actualiza la información sobre una API específica. El contenido indicado sustituirá a todo el contenido de la API del ID indicado. El ID es devuelto por la API de creación, o se puede encontrar en la URL de la interfaz de usuario del catálogo de API. This endpoint requires the `apm_api_catalog_write` permission. OAuth apps require the `apm_api_catalog_write` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/es/api/latest/scopes.md#api-management) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | --------------- | ------ | ----------------------- | | id [*required*] | string | ID of the API to modify | ### Request #### Body Data (required) {% tabs %} {% tab label="Model" %} | Field | Type | Description | | ----------------- | ------ | ----------------------------------------------------------- | | openapi_spec_file | binary | Objeto para datos de API en formato `OpenAPI` como archivo. | {% /tab %} {% tab label="Example" %} ```bash -F 'openapi_spec_file=@openapi-spec.yaml' ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} API updated successfully {% tabs %} {% tab label="Model" %} Response for `UpdateOpenAPI`. | Parent field | Field | Type | Description | | ---------------- | ---------------- | -------- | ------------------------------------------- | | | data | object | Data envelope for `UpdateOpenAPIResponse`. | | data | attributes | object | Attributes for `UpdateOpenAPI`. | | attributes | failed_endpoints | [object] | List of endpoints which couldn't be parsed. | | failed_endpoints | method | string | The endpoint method. | | failed_endpoints | path | string | The endpoint path. | | data | id | uuid | API identifier. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "failed_endpoints": [ { "method": "string", "path": "string" } ] }, "id": "90646597-5fdb-4a17-a240-647003f8c028" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} API not found error {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export id="90646597-5fdb-4a17-a240-647003f8c028" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X PUT "https://api.${DD_SITE}/api/v2/apicatalog/api/${id}/openapi" \ -H "Accept: application/json" \ -H "Content-Type: multipart/form-data" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -F openapi_spec_file=@string ``` {% /tab %} {% tab label="Go" %} ```go // Update an API returns "API updated successfully" response package main import ( "context" "encoding/json" "fmt" "io" "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 "managed_api" in the system ManagedAPIDataID := uuid.MustParse(os.Getenv("MANAGED_API_DATA_ID")) ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.UpdateOpenAPI", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAPIManagementApi(apiClient) resp, r, err := api.UpdateOpenAPI(ctx, ManagedAPIDataID, *datadogV2.NewUpdateOpenAPIOptionalParameters().WithOpenapiSpecFile(func() io.Reader { fp, _ := os.Open("openapi-spec.yaml"); return fp }())) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `APIManagementApi.UpdateOpenAPI`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `APIManagementApi.UpdateOpenAPI`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Update an API returns "API updated successfully" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ApiManagementApi; import com.datadog.api.client.v2.api.ApiManagementApi.UpdateOpenAPIOptionalParameters; import com.datadog.api.client.v2.model.UpdateOpenAPIResponse; import java.io.File; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.updateOpenAPI", true); ApiManagementApi apiInstance = new ApiManagementApi(defaultClient); // there is a valid "managed_api" in the system UUID MANAGED_API_DATA_ID = null; try { MANAGED_API_DATA_ID = UUID.fromString(System.getenv("MANAGED_API_DATA_ID")); } catch (IllegalArgumentException e) { System.err.println("Error parsing UUID: " + e.getMessage()); } try { UpdateOpenAPIResponse result = apiInstance.updateOpenAPI( MANAGED_API_DATA_ID, new UpdateOpenAPIOptionalParameters().openapiSpecFile(new File("openapi-spec.yaml"))); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ApiManagementApi#updateOpenAPI"); 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Update an API returns "API updated successfully" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.api_management_api import APIManagementApi # there is a valid "managed_api" in the system MANAGED_API_DATA_ID = environ["MANAGED_API_DATA_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["update_open_api"] = True with ApiClient(configuration) as api_client: api_instance = APIManagementApi(api_client) response = api_instance.update_open_api( id=MANAGED_API_DATA_ID, openapi_spec_file=open("openapi-spec.yaml", "rb"), ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Update an API returns "API updated successfully" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.update_open_api".to_sym] = true end api_instance = DatadogAPIClient::V2::APIManagementAPI.new # there is a valid "managed_api" in the system MANAGED_API_DATA_ID = ENV["MANAGED_API_DATA_ID"] opts = { openapi_spec_file: File.open("openapi-spec.yaml", "r"), } p api_instance.update_open_api(MANAGED_API_DATA_ID, opts) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Update an API returns "API updated successfully" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_api_management::APIManagementAPI; use datadog_api_client::datadogV2::api_api_management::UpdateOpenAPIOptionalParams; use std::fs; #[tokio::main] async fn main() { // there is a valid "managed_api" in the system let managed_api_data_id = uuid::Uuid::parse_str(&std::env::var("MANAGED_API_DATA_ID").unwrap()) .expect("Invalid UUID"); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.update_open_api", true); let api = APIManagementAPI::with_config(configuration); let resp = api .update_open_api( managed_api_data_id.clone(), UpdateOpenAPIOptionalParams::default() .openapi_spec_file(fs::read("openapi-spec.yaml").unwrap()), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Update an API returns "API updated successfully" response */ import * as fs from "fs"; import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.updateOpenAPI"] = true; const apiInstance = new v2.APIManagementApi(configuration); // there is a valid "managed_api" in the system const MANAGED_API_DATA_ID = process.env.MANAGED_API_DATA_ID as string; const params: v2.APIManagementApiUpdateOpenAPIRequest = { id: MANAGED_API_DATA_ID, openapiSpecFile: { data: Buffer.from(fs.readFileSync("openapi-spec.yaml", "utf8")), name: "openapi-spec.yaml", }, }; apiInstance .updateOpenAPI(params) .then((data: v2.UpdateOpenAPIResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}