API blocks

A first block:

Add a new pet to the store.

post

Add a new pet to the store.

Required scopes

This endpoint requires the following scopes:

• : modify pets in your account
• : read your pets

Authorizations

petstore_auth

OAuth2implicitRequired

Authorization URL:

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64OptionalExample: 10

namestringRequiredExample: doggie

photoUrlsstring[]Required

statusstring · enumOptional

pet status in the store

Possible values:

Responses

200

Successful operation

application/jsonapplication/xml

400

Invalid input

422

Validation exception

default

Unexpected error

post

/pet

HTTPcURLJavaScriptPython

POST /api/v3/pet HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Update an existing pet.

put

Update an existing pet by Id.

Required scopes

This endpoint requires the following scopes:

• : modify pets in your account
• : read your pets

Authorizations

petstore_auth

OAuth2implicitRequired

Authorization URL:

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64OptionalExample: 10

namestringRequiredExample: doggie

photoUrlsstring[]Required

statusstring · enumOptional

pet status in the store

Possible values:

Responses

200

Successful operation

application/jsonapplication/xml

400

Invalid ID supplied

404

Pet not found

422

Validation exception

default

Unexpected error

put

/pet

HTTPcURLJavaScriptPython

PUT /api/v3/pet HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Finds Pets by status.

get

Multiple status values can be provided with comma separated strings.

Required scopes

This endpoint requires the following scopes:

• : modify pets in your account
• : read your pets

Authorizations

petstore_auth

OAuth2implicitRequired

Authorization URL:

Query parameters

statusstring · enumOptional

Status values that need to be considered for filter

Default: availablePossible values:

Responses

200

successful operation

application/jsonapplication/xml

400

Invalid status value

default

Unexpected error

get

/pet/findByStatus

HTTPcURLJavaScriptPython

GET /api/v3/pet/findByStatus HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }
]

Deletes a pet.

delete

Delete a pet.

Required scopes

This endpoint requires the following scopes:

• : modify pets in your account
• : read your pets

Authorizations

petstore_auth

OAuth2implicitRequired

Authorization URL:

Path parameters

petIdinteger · int64Required

Pet id to delete

Header parameters

api_keystringOptional

Responses

200

Pet deleted

No content

400

Invalid pet value

default

Unexpected error

delete

/pet/{petId}

HTTPcURLJavaScriptPython

DELETE /api/v3/pet/{petId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Webhooks :

newPet

Payload

application/json

idinteger · int64Required

namestringRequired

tagstringOptional

Responses

200

Return a 200 status to indicate that the data was received successfully

No content

Payload

{
  "id": 1,
  "name": "text",
  "tag": "text"
}

Models: