PUT
/
api
/
apis
/
{apiId}
Update API Definition
curl --request PUT \
  --url https://{tenant}/api/apis/{apiId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "api_definition": {
    "api_id": "b84fe1a04e5648927971c0557971565c",
    "auth": {
      "auth_header_name": "authorization"
    },
    "definition": {
      "key": "version",
      "location": "header"
    },
    "name": "Update API name",
    "org_id": "664a14650619d40001f1f00f",
    "proxy": {
      "listen_path": "/updated-tyk-api-test/",
      "strip_listen_path": true,
      "target_url": "https://httpbin.org"
    },
    "use_oauth2": true,
    "version_data": {
      "not_versioned": true,
      "versions": {
        "Default": {
          "name": "Default"
        }
      }
    }
  }
}'
{
  "Message": "API updated",
  "Meta": null,
  "Status": "OK"
}

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

​
apiId
string
required

ID of API to get. Can either be internal or public API ID.

Body

application/json
​
api_definition
object
​
api_model
object
​
categories
string[]
​
created_at
string<date-time> | null
​
hook_references
object[] | null
​
is_site
boolean
​
oas
object | null
​
sort_by
integer
​
updated_at
string<date-time> | null
​
user_group_owners
string[] | null
​
user_owners
string[] | null

Response

API updated

​
ID
string
​
Message
string
​
Meta
any
​
Status
string