You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dist/lob-api-bundled.yml
+53-28Lines changed: 53 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
openapi: 3.0.3
2
2
info:
3
3
title: Lob
4
-
version: 1.20.0
4
+
version: 1.20.1
5
5
description: |
6
6
The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p>
7
7
license:
@@ -10592,6 +10592,17 @@ paths:
10592
10592
description: Retrieve a list of all created domains.
10593
10593
tags:
10594
10594
- URL Shortener
10595
+
parameters:
10596
+
- $ref: '#/components/parameters/limit'
10597
+
- $ref: '#/components/parameters/before_after'
10598
+
- in: query
10599
+
name: status
10600
+
description: Filter domains by their configuration status.
10601
+
schema:
10602
+
type: string
10603
+
enum:
10604
+
- configured
10605
+
- not_configured
10595
10606
responses:
10596
10607
'200':
10597
10608
description: Returns a list of all domains.
@@ -10896,7 +10907,14 @@ paths:
10896
10907
- URL Shortener
10897
10908
parameters:
10898
10909
- $ref: '#/components/parameters/limit'
10899
-
- $ref: '#/components/parameters/offset'
10910
+
- $ref: '#/components/parameters/before_after'
10911
+
- $ref: '#/components/parameters/campaign_id'
10912
+
- in: query
10913
+
name: domain_id
10914
+
description: Filters links by the provided domain id.
10915
+
schema:
10916
+
type: string
10917
+
pattern: ^(dom)_[a-zA-Z0-9]+$
10900
10918
responses:
10901
10919
'200':
10902
10920
description: Returns the deleted link object.
@@ -20779,8 +20797,14 @@ components:
20779
20797
description: The registered domain/hostname.
20780
20798
type: string
20781
20799
error_redirect_link:
20782
-
description: The 404 error redirect link.
20800
+
description: URL to redirect customers if a short link is broken or inactive.
20801
+
type: string
20802
+
status:
20803
+
description: The configuration status of the domain.
20783
20804
type: string
20805
+
enum:
20806
+
- configured
20807
+
- not_configured
20784
20808
created_at:
20785
20809
description: The date and time the domain was created.
20786
20810
type: string
@@ -20797,19 +20821,21 @@ components:
20797
20821
description: Only returned if the domain was successfully deleted.
20798
20822
type: boolean
20799
20823
domains_response:
20800
-
type: object
20801
-
properties:
20802
-
data:
20803
-
type: array
20804
-
description: List of domains.
20805
-
items:
20806
-
$ref: '#/components/schemas/domain_response'
20824
+
allOf:
20825
+
- $ref: '#/components/schemas/list'
20826
+
- type: object
20827
+
properties:
20828
+
data:
20829
+
type: array
20830
+
description: List of domains.
20831
+
items:
20832
+
$ref: '#/components/schemas/domain_response'
20807
20833
domain:
20808
20834
type: string
20809
20835
description: The registered domain/hostname.
20810
20836
error_redirect_link:
20811
20837
type: string
20812
-
description: The 404 error redirect link.
20838
+
description: URL to redirect customers if a short link is broken or inactive.
20813
20839
domains:
20814
20840
type: object
20815
20841
required:
@@ -20841,6 +20867,12 @@ components:
20841
20867
type: string
20842
20868
metadata:
20843
20869
$ref: '#/components/schemas/metadata'
20870
+
created_at:
20871
+
description: The date and time the link was created.
20872
+
type: string
20873
+
updated_at:
20874
+
description: The date and time the link was last updated.
20875
+
type: string
20844
20876
link_delete_response:
20845
20877
type: object
20846
20878
properties:
@@ -20863,23 +20895,15 @@ components:
20863
20895
metadata:
20864
20896
$ref: '#/components/schemas/metadata'
20865
20897
links_response:
20866
-
type: object
20867
-
properties:
20868
-
count:
20869
-
type: integer
20870
-
description: The number of results in the current response.
20871
-
limit:
20872
-
type: integer
20873
-
description: How many results to return.
20874
-
offset:
20875
-
type: integer
20876
-
description: An integer that designates the offset at which to begin returning results. Defaults to 0.
20877
-
data:
20878
-
type: array
20879
-
description: |
20880
-
list of links
20881
-
items:
20882
-
$ref: '#/components/schemas/link_response'
20898
+
allOf:
20899
+
- $ref: '#/components/schemas/list'
20900
+
- type: object
20901
+
properties:
20902
+
data:
20903
+
type: array
20904
+
description: List of links
20905
+
items:
20906
+
$ref: '#/components/schemas/link_response'
20883
20907
link_single:
20884
20908
type: object
20885
20909
required:
@@ -20892,6 +20916,7 @@ components:
20892
20916
$ref: '#/components/schemas/redirect_link'
20893
20917
domain:
20894
20918
description: The registered domain to be used for the short URL.
20919
+
default: lob.st
20895
20920
type: string
20896
20921
slug:
20897
20922
description: The unique path for the shortened URL, if empty a unique path will be used.
0 commit comments